查询服务部署实例列表 - ListV2DeploymentInstances
功能介绍
本接口用于查询当前租户的服务部署实例列表,并支持根据服务部署实例的状态进行筛选,包括运行中和已删除状态,同时支持分页和关键词筛选。适用于需要管理和监控服务实例状态的场景。调用此接口前,确保已具备相应的查询权限,并提供可选的筛选条件和分页参数。返回的列表将包含每个服务部署实例的基本信息,如部署名字、最新更新时间、状态等。如果当前租户没有符合条件的服务实例或提供的参数无效,将返回空列表或相应的异常信息,提示用户检查输入数据的有效性和权限。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts:service:listDeploymentInstances
Read
service *
-
-
-
URI
GET /v2/{project_id}/services/{id}/deployments/{name}/instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
| id | 是 | String | 参数解释: 服务唯一id |
| name | 是 | String | 参数解释: 服务部署名字,可以为all |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| status | 否 | Array of strings | 参数解释: 服务实例状态,一次支持多种状态筛选,多种状态以","连接,不能存在空格。默认不过滤。取值范围有4种RUNNING(运行中)、ERROR(错误)、INIT(初始化)、DELETED(已删除)。 约束限制: 不涉及。 |
| limit | 否 | Integer | 参数解释: 指定每一页返回的最大条目数。 约束限制: 不涉及。 取值范围: [1,500] 默认取值: 10。 |
| offset | 否 | String | 参数解释: 分页列表的起始页。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
| pod_name | 否 | String | 参数解释: pod名字。 取值范围: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| current | Integer | 参数解释: 当前页码,从0开始计数。 取值范围: 不涉及。 |
| data | Array of ServiceInstanceResponse objects | 参数解释: 服务实例列表。 |
| pages | Integer | 参数解释: 总页数,根据传入的limit字段和数据总条数计算得出。如总记录条数为10,limit(单页最大条目数)为3,则页数为4。 取值范围: 不涉及。 |
| size | Integer | 参数解释: 当前页数量。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 总记录条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_name | String | 参数解释: 服务实例名字。 取值范围: 不涉及。 |
| status | String | 参数解释: 服务实例状态。 取值范围: |
| weight | Integer | 参数解释: 服务实例权重。 取值范围: [0, 100] 或者为空。 |
| pod_count | Long | 参数解释: 服务实例pod数量。 取值范围: 不涉及。 |
| running_pod_count | Long | 参数解释: 服务实例运行中pod数量。 取值范围: 不涉及。 |
| update_at | Long | 参数解释: 服务实例最近更新时间。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
请求示例
查询指定部署列表。
GET https://{endpoint}/v2/{project_id}/services/{service_id}/deployments/{name}/instances 响应示例
状态码:200
部署实例列表。
{
"current" : 1,
"data" : [ {
"instance_name" : "infer-a07f5c03-18c5-4dfb-849a-c3506020a1f8-1ghsj",
"status" : "DELETED",
"pod_count" : 1,
"running_pod_count" : 1,
"update_at" : 1747766464765,
"weight" : 50
}, {
"instance_name" : "infer-a07f5c03-18c5-4dfb-849a-c3506020a1f8-ecfip",
"status" : "DELETED",
"update_at" : 1747785331567,
"pod_count" : 1,
"running_pod_count" : 1,
"weight" : 50
} ],
"pages" : 1,
"size" : 2,
"total" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 部署实例列表。 |
| 400 | 请求参数不合法。 |
| 401 | 鉴权非法。 |
| 403 | 权限不足。 |
| 404 | 资源未找到。 |
错误码
请参见错误码。