查询Endpoint列表

workspace_id

是

String

• 参数解释：工作空间ID。

• 约束限制：不涉及。

• 取值范围：获取方法，请参见获取工作空间ID。

• 默认取值：不涉及。

offset

否

Integer

• 参数解释：偏移量，表示从此偏移量开始查询。

• 约束限制：不涉及。

• 取值范围：offset大于等于0。

• 默认取值：默认为0。

limit

否

Integer

• 参数解释：指定每一页返回的最大条目数。

• 约束限制：不涉及。

• 取值范围：取值范围[1,100]。

• 默认取值：默认为10。

model_id

否

String

通过模型ID检索，32~36位的英文、数字、中划线(-)组合。

name

否

String

• 参数解释：Endpoint名称，通过名字搜索Endpoint的参数。

• 约束限制：不涉及。

• 取值范围：只能包含中文、字母、数字、下划线、中划线，支持模糊查询。

• 默认取值：不涉及。

endpoint_id

否

String

通过端点ID检索Endpoint的参数。获取方法，请参见获取端点ID。

type

否

Object

通过类型检索Endpoint的参数。

visibility

否

String

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

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

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

• ALL: 所有的；

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

X-Auth-Token

否

String

• 参数解释：租户Token。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

total

Integer

• 参数解释：符合条件的Endpoint总数。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

endpoints

Array of EndpointBriefInfo objects

符合条件的Endpoint简要信息列表。

visibility

String

• 参数解释：可见性。

• 约束限制：不涉及。

• 取值范围：

  • PRIVATE：私有

  • PUBLIC：公共

• 默认取值：PRIVATE。

id

String

• 参数解释：Endpoint ID。

• 约束限制：32~36位的英文、数字、中划线(-)组合。

• 取值范围：不涉及。

• 默认取值：不涉及。

name

String

• 参数解释：Endpoint名称。

• 约束限制：只能包含中文、字母、数字、下划线、中划线、半角句号（.）、空格。

• 取值范围：不涉及。

• 默认取值：不涉及。

type

String

• 参数解释：Endpoint的类型。

• 约束限制：不涉及。

• 取值范围：

  • service：Service EP，代表一个可接收Service请求资源组；

  • ray：RayCluter on k8s的EP，代表一个Ray集群；

  • inference：推理的EP，代表一个推理函数实例；

  • job：Job EP，代表一个可接收Job请求资源组；

  • ray_service：RayService on k8s的EP，代表一个RayService。

• 默认取值：不涉及。

status

String

• 参数解释：Endpoint状态。

• 约束限制：不涉及。

• 取值范围：

  • CREATING：创建中；

  • RUNNING：运行中；

  • CREATE_FAILED：创建失败；

  • DELETING：删除中；

  • DELETED：已删除；

  • UPDATING: 更新中；

  • UPDATE_FAILED：升级失败；

  • DELETE_FAILED：创建失败；

  • FROZEN：冻结；

  • INACTIVE：未开通（公共EP）；

  • TRIAL_ENDED：试用结束。

• 默认取值：不涉及。

description

String

• 参数解释：描述信息。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

create_time

String

• 参数解释：创建时间。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

update_time

String

• 参数解释：更新时间。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

owner

User object

租户信息。

cap

CapRef object

CAP信息。

reserved_resource

ReservedResource object

通用预留资源。

ray_resource

RayResourceInfo object

Ray资源配置。

error_code

String

• 参数解释：失败状态时的错误编码。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_msg

String

• 参数解释：失败状态时的错误信息。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

domain_name

String

• 参数解释：账户名称。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

domain_id

String

• 参数解释：账号ID。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

user_name

String

• 参数解释：用户名称。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

user_id

String

• 参数解释：用户ID。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

cap_id

String

• 参数解释：CapId。

• 约束限制：32~36位的英文、数字、中划线(-)组合。

• 取值范围：不涉及。

• 默认取值：不涉及。

version_id

String

• 参数解释：CapVersionId。

• 约束限制：32~36位的英文、数字、中划线(-)组合。

• 取值范围：不涉及。

• 默认取值：不涉及。

apu

ResourceDef object

资源定义信息。

dpu

ResourceDef object

资源定义信息。

mu

ResourceDemand object

资源需求量配置。

spec_code

String

• 参数解释：Endpoint状态。

• 约束限制：资源规格编码，从查询规格列表ListSpecs接口获取。

• 取值范围：不涉及。

• 默认取值：不涉及。

warm_up_num

Integer

预热资源量。

max_num

Integer

最大资源量，不填默认为预热资源量，即不使用弹性资源。

spec_code

String

• 参数解释：资源规格。

• 约束限制：不涉及。

• 取值范围：从规格列表查询获取。

• 默认取值：不涉及。

min

Integer

最小数。

max

Integer

最大数。

head_group_spec

HeadGroupSpec object

Ray Head配置。

worker_group_spec

Array of WorkerGroupSpec objects

Ray worker group配置。

spec_code

String

• 参数解释：资源规格。

• 约束限制：不涉及。

• 取值范围：从规格列表查询获取。

• 默认取值：不涉及。

name

String

• 参数解释：名称。

• 约束限制：不涉及。

• 取值范围：不涉及。

• 默认取值：不涉及。

spec_code

String

• 参数解释：资源规格。

• 约束限制：不涉及。

• 取值范围：从规格列表查询获取。

• 默认取值：不涉及。

min_replicas

Integer

最小副本数。

max_replicas

Integer

最大副本数。

error_code

String

• 参数解释：错误码。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_msg

String

• 参数解释：错误描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

solution_msg

String

• 参数解释：解决方案描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_code

String

• 参数解释：错误码。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_msg

String

• 参数解释：错误描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

solution_msg

String

• 参数解释：解决方案描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_code

String

• 参数解释：错误码。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_msg

String

• 参数解释：错误描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

solution_msg

String

• 参数解释：解决方案描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_code

String

• 参数解释：错误码。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

error_msg

String

• 参数解释：错误描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

solution_msg

String

• 参数解释：解决方案描述。

• 约束限制：该值不可修改。

• 取值范围：不涉及。

• 默认取值：不涉及。

200

查询Endpoint列表的响应体。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

408

Request timeout error。

500

Internal error。