更新时间:2024-12-20 GMT+08:00
分享

查询服务规格列表

功能介绍

查询服务规格列表,购买计算资源使用。

调试

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

URI

GET https://localhost.com/v1/specs

表1 Query参数

参数

是否必选

参数类型

描述

spec_code

String

规格编码。

spec_types

Array of strings

通过资源规格类型检索。

offset

Integer

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

  • 约束限制:不涉及。

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

  • 默认取值:默认为0。

limit

Integer

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

  • 约束限制:不涉及。

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

  • 默认取值:默认为10。

scenario

Object

  • 参数解释:规格使用场景。

  • 约束限制:不涉及。

  • 取值范围

    • 不填:表示不限制;

    • COMPUTE: 用于购买Ray计算资源时配置的物理节点规格;

    • ENDPOINT: 用于创建Endpoint时配置的资源组规格大小。

  • 默认取值:不涉及。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

total

Integer

总数。

spec_codes

Array of Spec objects

规格编码列表。

表3 Spec

参数

参数类型

描述

spec_code

String

  • 参数解释:资源规格。

  • 约束限制:不涉及。

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

  • 默认取值:不涉及。

spec_type

String

  • 参数解释:资源规格类型。

  • 约束限制:不涉及。

  • 取值范围

    • APU:APU类型;

    • DPU:DPU类型;

    • MU:MU类型;

    • RESOURCE_USAGE_UNIT:资源使用量类型;

    • RAY_APU:Ray APU类型;

    • RAY_DPU:Ray DPU类型。

    • RAY_CACHE:Ray缓存资源。

  • 默认取值:不涉及。

resource_type

String

  • 参数解释:资源类型。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

stride

Integer

  • 参数解释:步长。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

unit

String

  • 参数解释:单位。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

min_stride_num

Integer

资源步数,最小为10000,步长为1。输入范围还需要满足规格列表接口的步长白名单。

max_stride_num

Integer

资源步数,最小为10000,步长为1。输入范围还需要满足规格列表接口的步长白名单。

usage_measure_id

Integer

使用量单位标识。

usage_factor

String

  • 参数解释:使用量因子。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

stride_num_whitelist

Array of integers

步数白名单,返回时,步数必须是白名单中的值。

extra_info

SpecExtraInfo object

附加信息。

表4 SpecExtraInfo

参数

参数类型

描述

mu_multiple

Double

  • 参数解释:模型单元换算倍数

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

mu_code

String

  • 参数解释:模型单元编码。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 408

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

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

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

  • 取值范围:不涉及。

  • 默认取值:不涉及。

请求示例

响应示例

状态码

状态码

描述

200

查询规格列表响应。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

404

Not found error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码

相关文档