文档首页/ 数智融合计算服务/ API参考/ API/ fabric-ep/ Service实例管理/ 列举已部署的Service实例
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

列举已部署的Service实例

功能介绍

列举已部署的Service实例

URI

GET https://localhost.com/v1/workspaces/{workspace_id}/services/instances

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

  • 参数解释：Workspace的ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

通过service Instance id检索，32~36位的英文、数字、中划线（-）组合。

name

否

String

通过名字搜索Service Instance，支持模糊查询。

limit

否

Integer

指定每一页返回的最大条目数，取值范围[1,100]，默认为10。

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0，默认为0。

endpoint_id

否

String

通过ID检索Endpoint的参数。

source_id

否

String

Service ID或者Model ID。

version_id

否

String

Service version ID或者Model version ID。

type

否

String

Service的类型，可选值：

  • PGSQL_SERVICE：已废弃

  • LLM_MODEL：大语言模型

visibility

否

String

可见性检索的参数，可选值为：

  • PRIVATE: 私有，用户自己创建的；

  • PUBLIC:公共，查询所有公共的，包括其他用户创建的；

  • 默认为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。

sort_by

否

String

根据字段排序，可选值：

  • CREATE_TIME：创建时间。

order_by

否

String

排序方式，可选值：

  • ASC：正序排序

  • DESC: 倒序排序。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户token。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的service Istance总数。

service_instances

Array of ServiceInstanceBriefInfo objects

符合条件的service Instance列表。
表5 ServiceInstanceBriefInfo

参数

参数类型

描述

visibility

String

可见性：

  • PRIVATE：私有

  • PUBLIC：公共

    默认为PRIVATE

source

SourceRef object

来源信息，Service信息或者模型信息

id

String

服务实例的ID。获取方法，请参见获取推理服务实例ID。

name

String

一个Service Instance的名称，只能包含中文、字母、数字、下划线、中划线、点、空格

description

Description object

描述信息

endpoint_id

EndpointId object

endpoint空间ID

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

错误码

error_msg

String

错误描述

solution

String

解决方案

content_moderation_switch

String

  • 参数解释：模型内容审核开关。

  • 约束限制：不涉及。

  • 取值范围：

    • ON：开启内容审核；

    • OFF：关闭内容审核。

  • 默认取值：不涉及。
表6 SourceRef

参数

参数类型

描述

id

String

一种资源ID，32~36位的英文、数字、中划线（-）组合。

version_id

String

一种资源ID，32~36位的英文、数字、中划线（-）组合。
表7 Description

参数

参数类型

描述

-

String

描述信息
表8 EndpointId

参数

参数类型

描述

-

String

endpoint空间ID
表9 User

参数

参数类型

描述

domain_name

String

账户名称

user_name

String

用户名称
表10 ServiceType

参数

参数类型

描述

-

String

Service的类型，可选值：

  • PGSQL_SERVICE：已废弃

  • LLM_MODEL：大语言模型

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

solution_msg

String

解决方案描述

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

solution_msg

String

解决方案描述

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

solution_msg

String

解决方案描述

状态码： 408

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

solution_msg

String

解决方案描述

状态码： 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

solution_msg

String

解决方案描述

请求示例

无

响应示例

无

状态码

状态码

描述

200

查询service instance列表的响应体

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

408

Request timeout error

500

Internal error

错误码

请参见错误码。

父主题： Service实例管理

相关文档