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

查询服务列表 - ListV2Services

功能介绍

支持分页和筛选

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts::listServices

    List

    -

    -

    modelarts:service:list

    -

URI

GET /v2/{project_id}/services

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

账号的项目ID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

服务ID。

默认取值：

不涉及。

pool_id

否

String

参数解释：

资源池ID，查询指定资源池下的服务，默认不过滤。可通过查询资源池列表获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

pool_name

否

String

参数解释：

资源池name，查询指定资源池下的服务，默认不过滤。可通过查询资源池列表获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_key

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

  • create_at：按创建时间排序。

  • update_at：按更新时间排序。

默认取值：

update_at。

status

否

String

参数解释：

服务当前状态，查询指定状态的过滤。默认不过滤。

约束限制：

不涉及。

取值范围：

  • DEPLOYING：部署中。

  • FAILED：失败。

  • STOPPED：停止。

  • RUNNING：运行中。

  • DELETING：删除中。

  • STOPPING：停止中。

  • CONCERNING：告警。

  • UPGRADING：升级中。

  • ERROR：异常。

  • INTERRUPTING：中断中。

默认取值：

不涉及。

name

否

String

参数解释：

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

约束限制：

服务在删除之前名字不能重复。

取值范围：

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

默认取值：

不涉及。

auth_type

否

String

参数解释：

认证类型，默认不过滤。

约束限制：

不涉及。

取值范围：

  • TOKEN：IAM Token认证。

  • API_KEY：API Key认证。

  • NONE：无认证。

默认取值：

不涉及。

type

否

String

参数解释：

推理服务类型。

约束限制：

不涉及。

取值范围：

  • REAL_TIME：在线服务。

  • ASYNC_REAL_TIME：异步服务。

默认取值：

不涉及。

description

否

String

参数解释：

服务描述，模糊查询，默认不过滤。由用户创建服务时自行填写。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

workspace_id

否

String

参数解释：

工作空间ID。

取值范围：

  • 0：默认空间ID

  • 由数字和小写字母组成的32位字符：其他空间ID，可参考工作空间创建

约束限制：

不涉及。

默认取值：

不涉及。

user_name

否

String

参数解释：

创建者，即创建服务的用户名。

约束限制：

不涉及。

取值范围：

创建服务的用户名。

默认取值：

不涉及。

tags

否

String

参数解释：

标签，查询指定标签的服务，默认不过滤。根据标签过滤service参数，格式：每组tag之间使用英文逗号分隔，每个标签内的key和value使用英文竖划线分隔，例：tag_key1|tag_value1,tag_key2|tag_value2

约束限制：

不以逗号，竖划线开头，不以逗号结尾，不出现连续的竖划线和逗号，允许中文、西文、葡文等语言以及空格_.:/=+-@特殊字符，且字符间以逗号或者竖划线分隔。

取值范围：

不涉及。

默认取值：

不涉及。

asset_id

否

String

参数解释：

资产ID，查询使用了指定资产的服务，默认不过滤。可通过[资产管理][模型列表]获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_dir

否

String

参数解释：

排序方式

约束限制：

不涉及。

取值范围：

  • ASC: 递增排序。

  • DESC: 递减排序。

默认取值：

DESC。

limit

否

Integer

参数解释：

指定返回的最大条目数。

约束限制：

不涉及。

取值范围：

[1,500]

默认取值：

10。

offset

否

Integer

参数解释：

分页列表查询的偏移量。

约束限制：

offset必须是limit的整数倍。

取值范围：

不涉及。

默认取值：

0。

请求参数

表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个字符，可以包含字母、汉字、数字、连字符和下划线。

status

String

参数解释：

服务当前状态。

取值范围：

  • DEPLOYING：部署中。

  • FAILED：失败。

  • STOPPED：停止。

  • RUNNING：运行中。

  • DELETING：删除中。

  • STOPPING：停止中。

  • CONCERNING：告警。

  • UPGRADING：升级中。

  • ERROR：异常。

  • INTERRUPTING：中断中。

version

String

参数解释：

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

取值范围：

1.0.0 ~ 99.99.99，长度不超过8位。

version_count

Integer

参数解释：

服务版本数量。

取值范围：

不涉及。

description

String

参数解释：

服务描述，由用户创建服务时自行填写。

取值范围：

不涉及

type

String

参数解释：

推理服务类型。

约束限制：

不涉及。

取值范围：

  • REAL_TIME：在线服务。

  • ASYNC_REAL_TIME：异步服务。

默认取值：

不涉及。

deploy_type

String

参数解释：

部署类型。

取值范围：

  • SINGLE：单机单卡。

  • MULTI：多机多卡。

user_name

String

参数解释：

创建服务的用户名。

取值范围：

用户名。

workspace_id

String

参数解释：

工作空间ID。

取值范围：

  • 0：默认空间ID。

  • 由数字和小写字母组成的32位字符：其他空间ID，可参考工作空间创建。

create_at

Long

参数解释：

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

取值范围：

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

update_at

Long

参数解释：

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

取值范围：

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

auth_type

String

参数解释：

在线服务认证类型。

取值范围：

  • TOKEN：IAM Token认证。

  • API_KEY：API Key认证。

  • NONE：无认证。

task_type

String

参数解释：

模型类型。

取值范围：

  • TEXT_GENERATION：文本生成

  • IMAGE_UNDERSTANDING：图像理解

  • VIDEO_GENERATION：视频生成

  • IMAGE_GENERATION：图像生成

  • RERANK：重排序

  • VECTOR_MODEL：向量模型

  • EMBEDDING：Embedding嵌入

tags

Array of TagsResponse objects

参数解释：

在线服务标签数据。

schedule

Array of ScheduleConfigResponse objects

参数解释：

定时停止配置。

frozen_infos

Array of FrozenInfo objects

参数解释：

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

参数

参数类型

描述

key

String

参数解释：

标签键字段。

约束限制：

不涉及。

取值范围：

长度为1~128，标签的键可以包含任意语种字母、数字、空格，以及_ . : = + - @特殊字符，但首尾不能含有空格，不能以_sys_开头。

默认取值：

不涉及。

value

String

参数解释：

标签值字段。

取值范围：

长度为255，包括字母、数字、下划线、点、斜杠、等号、加号、减号和@符号。
表7 ScheduleConfigResponse

参数

参数类型

描述

due_time

Long

参数解释：

触发时间，UTC毫秒，13位时间戳。

取值范围：

不涉及。

duration

Integer

参数解释：

对应的时间单位的数值。

取值范围：

不涉及。

time_unit

String

参数解释：

调度时间单位。

取值范围：

  • MINUTES：分钟。

  • HOURS：小时。

  • DAYS：天。

type

String

参数解释：

调度类型，当前仅支持取值为STOP。

取值范围：

  • STOP：停止。

processed

Boolean

参数解释：

表示是否处理完成。

取值范围：

  • true：该定时任务已经执行过。

  • false：该定时任务尚未执行。
表8 FrozenInfo

参数

参数类型

描述

effect

Integer

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

  • 1：冻结后可释放

  • 2：冻结后不可释放

请求示例

查询服务列表。其中limit表示一次查询返回的最大数量，offset表示从第几个开始往后返回，status必须为大写，name为模糊查询字段，表示本次查询结果中服务name所包含的值，id为精准查询字段，表示本次查询结果的服务ID。

GET https://{endpoint}/v2/{project_id}/services?limit=50&offset=0&type=REAL_TIME&status=STOPPED&name=test&id=testid

响应示例

状态码：200

服务列表信息。

{
  "current" : 0,
  "data" : [ {
    "id" : "841e8dc2-2640-4916-ad21-a18b147b9149",
    "name" : "service_name***example",
    "status" : "STOPPED",
    "version" : "0.0.1",
    "version_count" : 1,
    "description" : "infer-description",
    "type" : "REAL_TIME",
    "deploy_type" : "SINGLE",
    "user_name" : "user_name***example",
    "workspace_id" : "0",
    "create_at" : 1747990876171,
    "update_at" : 1747994527244,
    "auth_type" : "API_KEY",
    "task_type" : "TEXT_GENERATION",
    "tags" : [ {
      "key" : "标签key",
      "value" : "标签value"
    } ],
    "schedule" : [ {
      "due_time" : 1749798035000,
      "duration" : 3,
      "processed" : true,
      "time_unit" : "HOURS",
      "type" : "STOP"
    } ]
  } ],
  "pages" : 1,
  "size" : 1,
  "total" : 1
}

状态码

状态码

描述

200

服务列表信息。

错误码

请参见错误码。