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

查询服务部署列表 - ListV2Deployments

功能介绍

支持分页和筛选，适用于用户在管理控制台或通过API需要查看特定条件下（如服务状态、名称等）的部署列表的情况。调用此接口前，用户必须具有查询部署列表的权限，并提供合法的分页参数（如页码、每页条数）和筛选条件（如部署状态、名称等）。调用成功后，系统将返回符合筛选条件的部署列表，包含指定页码的数据，并返回总页数和总记录数。如果用户没有查询部署列表的权限，或提供的分页参数和筛选条件不合法，调用将返回相应的错误信息。如果系统在查询过程中遇到内部错误，也将返回错误信息并记录日志。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:service:listDeployments

    Read

    service *

    -

    -

    -

URI

GET /v2/{project_id}/services/{service_id}/deployments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

账号的项目ID。

默认取值：

不涉及。

service_id

是

String

参数解释： 服务ID，在创建服务时即可在返回体中获取，也可通过查询服务列表获取当前用户拥有的服务，其中service_id字段即为服务ID。 约束限制： 不涉及。 取值范围： 服务ID。 默认取值： 不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

sort_key

否

String

参数解释：

排序字段，多个字段以","分隔，支持create_at, update_at，默认值update_at。

约束限制：

不涉及。

取值范围：

  • create_at：按创建时间排序。

  • update_at：按更新时间排序。

默认取值：

update_at。

status

否

String

参数解释：

当取值为all时查询包含指定天数内已删除的部署，与delete_after同时使用；当取值为空或非all时进查询未删除的部署。

约束限制：

不涉及。

取值范围：

  • all：查询包含已删除。

默认取值：

空。

sort_dir

否

String

参数解释：

排序方式

约束限制：

不涉及。

取值范围：

  • ASC: 递增排序。

  • DESC: 递减排序。

默认取值：

DESC。

limit

否

Integer

参数解释：

指定返回的最大条目数。

约束限制：

不涉及。

取值范围：

[1,500]

默认取值：

10。

offset

否

Integer

参数解释：

分页列表查询的偏移量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0。

delete_after

否

Integer

参数解释：

表示查询包含指定天数内已删除的部署，与status同时使用，仅当status取值为all时生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

7

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及。

取值范围：

  • application/json。

  • application/json;charset=utf-8。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Array of data objects

参数解释：

在线服务数据。

current

Integer

参数解释：

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

取值范围：

不涉及。

size

Integer

参数解释：

当前页数量。

取值范围：

不涉及。

pages

Integer

参数解释：

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

取值范围：

不涉及。

total

Integer

参数解释：

总记录条数。

取值范围：

不涉及。
表5 data

参数

参数类型

描述

id

String

参数解释：

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

取值范围：

服务ID。

name

String

参数解释：

部署名，用户在创建服务时自定义。

取值范围：

支持1-128个字符，可以包含字母、汉字、数字、连字符和下划线。

infer_name

String

参数解释：

部署ID。

取值范围：

不涉及

service_group_name

String

参数解释：

服务实例组id。

取值范围：

不涉及

status

String

参数解释：

服务当前状态，一次只支持一种状态筛选。默认不过滤。

取值范围：

  • DEPLOYING：部署中。

  • FAILED：失败。

  • STOPPED：停止。

  • RUNNING：运行中。

  • DELETING：删除中。

  • STOPPING：停止中。

  • CONCERNING：告警。

  • DELETED：已删除。

  • RESTARTING：重启中。

  • UPGRADING：升级中。

  • ERROR：异常。

  • INTERRUPTING：中断中。

lts_state

String

参数解释：

部署对接lts状态。

取值范围：

  • ON：开启。

  • OFF：关闭。

mirror_traffic_enable

Boolean

参数解释：

是否开启镜像流量。

取值范围：

不涉及

mirror_traffic_weight

String

参数解释：

镜像流量权重。

取值范围：

50。

weight

Integer

参数解释：

权重百分比，分配到此模型的流量权重，仅当模型部署为在线服务时需要配置。

取值范围：

[0, 100]。

traffic_ratio

String

参数解释：

流量比例，单个部署实例预期接收用户的流量与总流量比值，是由流量权重配置和部署状态计算所得的值。

取值范围：

0.00%~100.00%。

pool_id

String

参数解释：

专属资源池ID。

取值范围：

50。

version

String

参数解释：

服务版本号，以数字及点号组成，形如1.0.1。

取值范围：

版本长度不超过8位。

deploy_type

String

参数解释：

部署类型。

取值范围：

  • SINGLE：单机单卡。

  • MULTI：多机多卡。

  • DIST：分布式部署。

create_at

Long

参数解释：

创建时间，根据创建时的当前时间自动生成。

取值范围：

毫秒级时间戳，13位数字

update_at

Long

参数解释：

更新时间，根据更新时的当前时间自动生成。

取值范围：

毫秒级时间戳，13位数字。

frozen_infos

Array of FrozenInfo objects

参数解释：

当服务或者部署被冻结时返回的冻结类型信息。
表6 FrozenInfo

参数

参数类型

描述

scene

String

冻结场景。可选值如下：

  • ARREAR：欠费冻结

  • POLICE：公安冻结

  • ILLEGAL：违规冻结

effect

Integer

冻结后的影响。可选值如下：

  • 1：冻结后可释放

  • 2：冻结后不可释放

请求示例

查询服务部署列表。status为all时，支持查询指定天数内已删除的部署。

GET https://{endpoint}/v2/{project_id}/services/{service_id}/deployments?limit=50&offset=0&status=all

响应示例

状态码：200

服务列表信息。

{
  "current" : 0,
  "data" : [ {
    "id" : "841e8dc2-2640-4916-ad21-a18b147b9149",
    "name" : "service-ad4f",
    "status" : "STOPPED",
    "version" : "0.0.0",
    "deploy_type" : "SINGLE",
    "create_at" : 1747990876171,
    "update_at" : 1747994527244
  } ],
  "pages" : 1,
  "size" : 1,
  "total" : 1
}

状态码

状态码

描述

200

服务列表信息。

错误码

请参见错误码。