文档首页/ AI开发平台ModelArts/ API参考/ 服务管理/ 查询服务列表
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

查询服务列表

功能介绍

查询模型服务列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。
表2 Query参数

参数

是否必选

参数类型

描述

service_id

否

String

服务ID，在创建服务时即可在返回体中获取，也可通过查询服务列表接口获取当前用户拥有的服务，其中service_id字段即为服务ID。默认不过滤服务ID。

service_name

否

String

服务名称，由用户创建时指定，默认不过滤服务名。

model_id

否

String

模型ID，在创建AI应用时即可在返回体中获取，也可通过查询AI应用列表接口获取当前用户拥有的AI应用，其中model_id字段即为模型ID。默认不过滤模型ID。

workspace_id

否

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

infer_type

否

String

推理方式，默认不过滤推理方式。取值包含：

  • real-time：在线服务

  • batch：批量服务

  • edge: 边缘服务

status

否

String

服务状态，默认不过滤服务状态，取值包含：

  • running：运行中，服务正常运行。

  • deploying：部署中，服务正在部署，包含打镜像和调度资源部署。

  • concerning：告警，后端实例部分存在异常。

  • failed：失败，服务部署失败，失败原因可以看事件和日志标签页。

  • stopped：停止。

  • finished：只有批量服务会有这个状态，表示运行完成。

  • stopping: 停止中。

  • deleting: 删除中。

  • pending: 待启动，仅在线有这个状态。

  • waiting: 资源排队中，仅在线服务有这个状态。

offset

否

Integer

分页列表的起始页，默认为0。

limit

否

Integer

指定每一页返回的最大条目数，默认为1000。

sort_by

否

String

指定排序字段，枚举值如下：

  • publish_at: 服务发布时间，默认值

  • service_name: 服务名称

  • transition_at：更新时间

order

否

String

排序方式，枚举值如下：

  • asc : 递增排序

  • desc: 递减排序，默认值

tags

否

String

标签，默认不过滤标签。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

不分页的情况下符合查询条件的总服务数量。

count

Integer

当前查询结果的服务数量，不设置offset、limit查询参数时，count与total相同。

services

Array of ListServices objects

查询到的服务集合。
表5 ListServices

参数

参数类型

描述

failed_times

Long

服务调用失败次数。

owner

String

服务归属用户。

due_time

Number

在线服务自动停止时间，距“1970.1.1 0:0:0 UTC”毫秒数，未配置自动停止则不返回。

finished_time

Number

批量服务完成时间，距“1970.1.1 0:0:0 UTC”的毫秒数；仅当服务是批量服务时返回。

infer_type

String

推理方式，取值包含：

  • real-time：在线服务

  • batch：批量服务

  • edge：边缘服务

service_name

String

服务名称。

description

String

服务描述。

project

String

服务归属项目。

invocation_times

Long

服务的总调用次数。

publish_at

Long

服务最新的发布时间，距“1970.1.1 0:0:0 UTC”的毫秒数。

workspace_id

String

工作空间ID。

schedule

Array of Schedule objects

服务调度配置，未配置则不返回。

start_time

Number

批量服务启动时间，距“1970.1.1 0:0:0 UTC”的毫秒数；仅当服务是批量服务时返回。

operation_time

Number

当前请求的操作时间。

is_shared

Boolean

是否是订阅的服务。True表示为订阅服务。

service_id

String

服务ID。

progress

Integer

部署进度，当状态是deploying时返回。

shared_count

Number

订阅的服务数。

tenant

String

服务归属租户。

status

String

服务状态，取值包含：

  • running：运行中，服务正常运行。

  • deploying：部署中，服务正在部署，包含打镜像和调度资源部署。

  • concerning：告警，后端实例部分存在异常。

  • failed：失败，服务部署失败，失败原因可以看事件和日志标签页。

  • stopped：停止。

  • finished：只有批量服务会有这个状态，表示运行完成。

is_opened_sample_collection

String

是否打开数据采集，默认“false”。

transition_at

Number

服务状态转化时间。

is_free

Boolean

服务是否是免费规格类型。

additional_properties

Map<String,String>

服务附加属性，未配置则不返回。
表6 Schedule

参数

参数类型

描述

duration

Integer

对应时间单位的数值，比如2小时后停止，则time_unit填HOURS，duration填2。

time_unit

String

调度时间单位，可选DAYS/HOURS/MINUTES。

type

String

调度类型，当前仅支持取值为stop，即运行指定时间后自动停止。

请求示例

GET https://{endpoint}/v1/{project_id}/services

响应示例

状态码： 200

服务列表

{
  "total_count" : 1,
  "count" : 1,
  "services" : [ {
    "failed_times" : 1,
    "owner" : "b575785bcece44beb23597770fb819f9",
    "infer_type" : "real-time",
    "service_name" : "mnist",
    "description" : "",
    "project" : "b575785bcece44beb23597770fb819f9",
    "invocation_times" : 50,
    "publish_at" : 1243143243,
    "workspace_id" : 0,
    "is_shared" : false,
    "service_id" : "195c1f2d-136d-40af-a0f3-db5717d2634a",
    "shared_count" : 0,
    "tenant" : "b575785bcece44beb23597770fb819f9",
    "status" : "running"
  } ]
}

状态码

状态码

描述

200

服务列表

错误码

请参见错误码。

父主题： 服务管理

相关文档