文档首页/ 魔坊（ModelArts）模型训推平台/ API参考/ 模型推理（新版）/ 服务部署实例管理/ 查询服务部署的pod的列表 - ListV2DeploymentPods
更新时间：2026-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询服务部署的pod的列表 - ListV2DeploymentPods

功能介绍

本接口用于查询指定服务部署的pod列表，并支持选择是否只获取当前运行中的pod。适用于需要管理和监控服务部署pod状态的场景。调用此接口前，确保已具备相应的查询权限，并提供有效的服务ID、部署ID和可选的筛选参数pod status（如是否只获取当前运行中的pod）。返回的列表将包含每个pod的基本信息，如pod名称、pod所在node的IP、pod所在node名字、pod角色、状态、最近更新时间等。如果指定的服务ID无效或当前服务没有pod，将返回空列表或相应的异常信息，提示用户检查输入数据的有效性和权限。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:service:listDeploymentPods

    Read

    service *

    -

    -

    -

URI

GET /v2/{project_id}/services/{id}/deployments/{deployment_name}/instances/{name}/pods

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

账号的项目ID。

默认取值：

不涉及。

id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

服务ID。

默认取值：

不涉及。

deployment_name

是

String

参数解释：

部署名称，在创建部署时即可在返回体中获取，也可通过查询服务部署列表获取当前用户拥有的部署，其name字段即为部署名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

是

String

参数解释：

服务实例名字，可以为all，为all时去查询所有的服务实例。

约束限制：

不涉及。

取值范围：

服务实例名字。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

status

否

Array of strings

参数解释：

pod状态，一次支持多种状态筛选，多种状态以","连接，不能存在空格。默认不过滤。取值范围有7种RUNNING（运行中）、PENDING（未就绪）、SUCCEEDED（成功）、FAILED（失败）、ABNORMAL（异常）、UNKNOWN（未知）、DELETED（已删除）。

约束限制：

不涉及。

limit

否

Integer

参数解释：

指定每一页返回的最大条目数。

约束限制：

不涉及。

取值范围：

[1,500]

默认取值：

10。

offset

否

String

参数解释：

分页列表的起始页。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

pod_name

否

String

参数解释：

pod名字。

取值范围：

不涉及。

pod_id

否

String

参数解释：

pod ID。

取值范围：

不涉及。

pod_node_ip

否

String

参数解释：

pod节点IP地址。

取值范围：

不涉及。

pod_node_name

否

String

参数解释：

pod节点名称。

取值范围：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

current

Integer

参数解释：

当前页码，从0开始计数。

取值范围：

不涉及。

data

Array of ServicePodResponse objects

参数解释：

服务的pod的列表。

pages

Integer

参数解释：

总页数，根据传入的limit字段和数据总条数计算得出。如总记录条数为10，limit（单页最大条目数）为3，则页数为4。

取值范围：

不涉及。

size

Integer

参数解释：

当前页数量。

取值范围：

不涉及。

total

Integer

参数解释：

总记录条数。

取值范围：

不涉及。
表5 ServicePodResponse

参数

参数类型

描述

pod_id

String

参数解释：

od ID。

取值范围：

不涉及。

pod_name

String

参数解释：

pod名字。

取值范围：

不涉及。

pod_node_ip

String

参数解释：

pod所在node的IP。

取值范围：

不涉及。

pod_node_name

String

参数解释：

pod所在node的名字。

取值范围：

不涉及。

pod_role

String

参数解释：

pod角色。

取值范围：

不涉及。

status

String

参数解释：

pod服务状态。

取值范围：

有7种状态。RUNNING（运行中）、PENDING（未就绪）、SUCCEEDED（成功）、FAILED（失败）、ABNORMAL（异常）、UNKNOWN（未知）、DELETED（已删除）。

update_time

Long

参数解释：

最近更新时间。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

ModelArts错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

具体错误信息。

取值范围：

不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

ModelArts错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

具体错误信息。

取值范围：

不涉及。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

ModelArts错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

具体错误信息。

取值范围：

不涉及。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

ModelArts错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

具体错误信息。

取值范围：

不涉及。

请求示例

查询指定pod列表。

GET https://{endpoint}/v2/{project_id}/services/{service_id}/deployments/{deployment_id}/instances/{name}/pods?status=DELETED,SUCCEEDED

响应示例

状态码：200

Pod列表。

{
  "current" : 0,
  "data" : [ {
    "pod_id" : "7e92b18d-555d-4155-887b-3c7aedf267e9",
    "pod_name" : "infer-e274e26d-8348-48b5-ab20-143860879899-au4bc-role-0-65xmt6s",
    "pod_node_ip" : "100.**.**.**",
    "pod_node_name" : "os-node-created-5l9bf",
    "pod_role" : "role-0",
    "status" : "RUNNING"
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 1
}

状态码

状态码

描述

200

Pod列表。

400

请求参数不合法。

401

鉴权非法。

403

权限不足。

404

资源未找到。

错误码

请参见错误码。