数智融合计算服务-查询Endpoint列表:响应参数

时间:2025-02-12 15:01:09

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

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

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

endpoints

Array of EndpointBriefInfo objects

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

表5 EndpointBriefInfo

参数

参数类型

描述

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。

    • sql:SQL EP,代表一个可接收SQL请求资源组。

  • 默认取值:不涉及。

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

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

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表6 User

参数

参数类型

描述

domain_name

String

  • 参数解释:账户名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

domain_id

String

  • 参数解释:账号ID。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

user_name

String

  • 参数解释:用户名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

user_id

String

  • 参数解释:用户ID。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表7 CapRef

参数

参数类型

描述

cap_id

String

  • 参数解释:CapId。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

version_id

String

  • 参数解释:CapVersionId。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表8 ReservedResource

参数

参数类型

描述

apu

ResourceDef object

资源定义信息。

dpu

ResourceDef object

资源定义信息。

mu

ResourceDemand object

资源需求量配置。

表9 ResourceDef

参数

参数类型

描述

spec_code

String

  • 参数解释:Endpoint状态。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

warm_up_num

Integer

预热资源量。

max_num

Integer

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

表10 ResourceDemand

参数

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

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

  • 默认取值:不涉及。

min

Integer

最小数。

max

Integer

最大数。

表11 RayResourceInfo

参数

参数类型

描述

head_group_spec

HeadGroupSpec object

Ray Head配置。

worker_group_spec

Array of WorkerGroupSpec objects

Ray worker group配置。

表12 HeadGroupSpec

参数

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

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

  • 默认取值:不涉及。

表13 WorkerGroupSpec

参数

参数类型

描述

name

String

  • 参数解释:名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

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

  • 默认取值:不涉及。

min_replicas

Integer

最小副本数。

max_replicas

Integer

最大副本数。

状态码: 400

表14 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 401

表15 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 408

表16 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

support.huaweicloud.com/api-fabric/ListEndpoints.html