文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ Service实例管理/ 列举已部署的服务实例

更新时间：2025-09-15 GMT+08:00

查看PDF

列举已部署的服务实例

功能介绍

列举已部署的服务实例列表。用户可通过该接口列举已部署的服务实例列表，接口支持分页查询、支持通过名称、服务实例ID、端点ID、可见性查询。支持排序。返回为符合过滤条件的服务实例列表。此接口为同步接口，无配套使用接口。支持查询公共的服务实例。

URI

GET /v1/workspaces/{workspace_id}/services/instances

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间的ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
id	否	String	参数解释：通过服务实例id检索。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
name	否	String	参数解释：通过名字搜索服务实例，支持模糊查询。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
limit	否	Integer	参数解释：指定每一页返回的最大条目数。约束限制：不涉及。取值范围：[1,100]。默认取值：10。
offset	否	Integer	参数解释：偏移量，表示从此偏移量开始查询。约束限制：不涉及。取值范围：[0,1000000000]。默认取值：0。
endpoint_id	否	String	参数解释：通过ID检索Endpoint的参数。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
source_id	否	String	参数解释：Service ID或者Model ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
version_id	否	String	参数解释：Service version ID或者Model version ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
type	否	String	参数解释：Service的类型。约束限制：不涉及。取值范围：LLM_MODEL：大语言模型，PGSQL_SERVICE：已废弃。默认取值：不涉及。
visibility	否	String	参数解释：可见性检索的参数。约束限制：不涉及。取值范围： PRIVATE: 私有，用户自己创建的； PUBLIC: 公共，查询所有公共的，包括其他用户创建的。默认取值：为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。
sort_by	否	String	参数解释：根据字段排序。约束限制：不涉及。取值范围：CREATE_TIME：创建时间。默认取值：不涉及。
order_by	否	String	参数解释：排序方式。约束限制：不涉及。取值范围：ASC：正序排序；DESC：倒序排序。默认取值：DESC。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释：租户token。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：符合条件的service Istance总数。约束限制：不涉及。取值范围：[0,10000]。默认取值：不涉及。
service_instances	Array of ServiceInstanceBriefInfo objects	参数解释：符合条件的service Instance列表。约束限制：[0,1000]。

表5 ServiceInstanceBriefInfo
参数	参数类型	描述
visibility	String	参数解释：可见性。约束限制：不涉及。取值范围： PRIVATE：私有 PUBLIC：公共默认取值：PRIVATE。
source	SourceRef object	参数解释：来源信息，Service信息或者模型信息。约束限制：不涉及。
id	String	参数解释：服务实例的ID。获取方法，请参见获取推理服务实例ID。约束限制：不涉及。取值范围：长度为[32,36]的中文、字母、数字、中划线(-)的组合。默认取值：不涉及。
name	String	参数解释：一个服务实例的名称。约束限制：不涉及。取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、点、空格的组合。默认取值：不涉及。
description	String	参数解释：描述信息。约束限制：不涉及。取值范围：长度为[0,1024]的除了 “!”、“<”、“>”、“=”、“&”、“"”、“'” 之外的任意字符的组合。默认取值：不涉及。
endpoint_id	String	参数解释：端点ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
status	String	参数解释：运行状态。约束限制：不涉及。取值范围： PENDING：待处理 CREATING：创建中 RUNNING：运行中 UPDATING：更新中 SUCCEEDED：成功 FAILED：失败 STOPPING：停止中 STOPPED：已停止 DELETING：删除中 DELETED：已删除 INACTIVE：待激活 TRIAL_ENDED：已结束默认取值：不涉及。
create_time	String	参数解释：创建时间。约束限制：不涉及。
update_time	String	参数解释：更新时间。约束限制：不涉及。
duration	Long	参数解释：运行时长。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
create_user	User object	参数解释：租户信息，包含账户名称和用户名称。约束限制：不涉及。
type	ServiceType object	参数解释：Service的类型。约束限制：不涉及。取值范围： PGSQL_SERVICE：已废弃 LLM_MODEL：大语言模型默认取值：不涉及。
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,4096]。默认取值：不涉及。
solution	String	参数解释：解决方案。约束限制：不涉及。取值范围：长度为[0,4096]。默认取值：不涉及。
config	AppInstanceConfig object	参数解释：启动App实例时输入的配置。约束限制：不涉及。
content_moderation_switch	String	参数解释：模型内容审核开关。约束限制：不涉及。取值范围： ON：开启内容审核； OFF：关闭内容审核。默认取值：不涉及。
content_output_moderation_switch	String	参数解释：模型内容审核开关。约束限制：不涉及。取值范围： ON：开启内容审核； OFF：关闭内容审核。默认取值：不涉及。

表6 SourceRef
参数	参数类型	描述
id	String	参数解释：来源ID。有不同的类型，对于推理服务实例，则为模型的ID。约束限制：不涉及。取值范围：长度为[1,36]的英文字母、数字、中划线(-)的组合。默认取值：不涉及。
version_id	String	参数解释：版本ID。有不同的类型，对于推理服务实例，则为模型版本ID 约束限制：不涉及。取值范围：长度为[1,36]的英文字母、数字、中划线(-)的组合。默认取值：不涉及。

表7 User
参数	参数类型	描述
domain_name	String	参数解释：账户名称。约束限制：不涉及。取值范围：[0,64]。默认取值：不涉及。
user_name	String	参数解释：用户名称。约束限制：不涉及。取值范围：[0,64]。默认取值：不涉及。

表8 ServiceType
参数	参数类型	描述
-	String	参数解释：Service的类型。约束限制：不涉及。取值范围： PGSQL_SERVICE：已废弃 LLM_MODEL：大语言模型默认取值：不涉及。

表9 AppInstanceConfig
参数	参数类型	描述
model_instance_config	ModelServiceInstanceConfig object	参数解释：模型服务实例的配置，在DeployService中使用。约束限制：不涉及。

**表10** ModelServiceInstanceConfig
参数	参数类型	描述
resource	ResourceDemand object	参数解释：资源需求量配置。约束限制：不涉及。

**表11** ResourceDemand
参数	参数类型	描述
min	Integer	参数解释：最小数。约束限制：不涉及。取值范围：[1,1000]。默认取值：不涉及。
max	Integer	参数解释：最大数。约束限制：不涉及。取值范围：[1,1000]。默认取值：不涉及。
spec_code	String	参数解释：资源规格，从规格列表查询获取。约束限制：不涉及。取值范围：长度为[1,64]。默认取值：不涉及。

状态码：400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

状态码：401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

状态码：404

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

状态码：408

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

状态码：500

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

请求示例

无

响应示例

状态码：200

查询service instance列表的响应体。

{
  "total" : 1,
  "service_instances" : [ {
    "visibility" : "PRIVATE",
    "source" : {
      "id" : "0b5633ba2b904511ad514346f4d23d4b",
      "version_id" : "0b5633ba2b904511ad514346f4d23d4b"
    },
    "id" : "0b5633ba2b904511ad514346f4d23d4b",
    "name" : "serviceInstanceName1",
    "description" : "description",
    "endpoint_id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6",
    "status" : "",
    "create_time" : "2023-05-30T12:24:30.401Z",
    "update_time" : "2023-05-30T12:24:30.401Z",
    "duration" : 0,
    "create_user" : {
      "domain_name" : "string",
      "user_name" : "string"
    },
    "type" : "LLM_MODEL",
    "error_code" : "lakehouse.00010003",
    "error_msg" : "failed",
    "solution" : "failed",
    "config" : {
      "model_instance_config" : {
        "resource" : {
          "min" : 1,
          "max" : 1000,
          "spec_code" : "string"
        }
      }
    },
    "content_moderation_switch" : "ON",
    "content_output_moderation_switch" : "OFF"
  } ]
}

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码	描述
200	查询service instance列表的响应体。
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
408	Request Time-out
500	InternalServerError

错误码

请参见错误码。

父主题： Service实例管理

上一篇：Service实例管理

下一篇：查看部署的服务实例详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消