查询资源规格列表
功能介绍
查询资源规格列表接口用于获取可用的资源规格信息。该接口适用于以下场景：当需要查看或选择资源规格以创建资源池、分配资源或了解可用资源规格时，用户可通过此接口获取资源规格的详细信息。使用该接口的前提条件是用户具有相应的权限（如管理员权限或资源管理权限）。调用接口成功后，系统将返回资源规格的列表，包括规格ID、名称、CPU核数、内存大小、存储容量等详细信息。若用户无权限访问该接口或系统中未配置资源规格，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/resourceflavors
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID，获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
continue |
否 |
String |
参数解释：分页查询的偏移标志。 约束限制：不涉及。 取值范围：取值来自用户上一次分页查询响应结果中metadata.continue中的值，值为空默认无偏移。 默认取值：不涉及。 |
|
limit |
否 |
Integer |
参数解释：分页单次查询返回的资源数量。 约束限制：不涉及。 取值范围：0 - 500。 默认取值：500。 |
|
labelSelector |
否 |
String |
参数解释：标签筛选查询。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释：资源的API版本。 取值范围：可选值如下：
|
|
kind |
String |
参数解释：资源的类型。 取值范围：可选值如下：
|
|
metadata |
metadata object |
参数解释：资源规格列表的元信息。 |
|
items |
Array of ResourceFlavor objects |
参数解释：资源规格列表。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
continue |
String |
参数解释：分页查询的偏移标志。 取值范围：取值来自用户上一次分页查询响应结果中metadata.continue中的值，值为空默认无偏移。 |
|
remainingItemCount |
Integer |
参数解释：分页查询中剩余资源的数量。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释：资源的API版本。 取值范围：可选值如下：
|
|
kind |
String |
参数解释：资源的类型。 取值范围：可选值如下：
|
|
metadata |
metadata object |
参数解释：资源规格的元信息。 |
|
spec |
ResourceFlavorSpec object |
参数解释：资源规格的规格信息。 |
|
status |
ResourceFlavorStatus object |
参数解释：资源规格的状态信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：资源规格的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
labels |
ResourceFlavorLabel object |
参数解释：资源规格的标签信息。 |
|
annotations |
ResourceFlavorAnnotation object |
参数解释：资源规格的注释信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts/scope |
String |
参数解释：资源规格支持作业类型，以“.”分割。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts.flavor/image.filter |
String |
参数解释：资源规格支持的私有镜像的过滤条件。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：资源规格类型。 取值范围：可选值如下：
|
|
cpuArch |
String |
参数解释：资源规格实例的计算架构。 取值范围：可选值如下：
|
|
cpu |
String |
参数解释：资源规格实例的CPU核心数量。 取值范围：不涉及。 |
|
memory |
String |
参数解释：资源规格实例的内存大小。以Gi为单位。 取值范围：不涉及。 |
|
gpu |
gpu object |
参数解释：资源规格实例的GPU资源信息。 |
|
npu |
npu object |
参数解释：资源规格实例的NPU资源信息。 |
|
dataVolume |
Array of dataVolume objects |
参数解释：资源规格实例的存储资源信息。 |
|
billingModes |
Array of integers |
参数解释：资源规格支持的计费模式。 |
|
billingCode |
String |
参数解释：资源规格计费码。 取值范围：不涉及。 |
|
jobFlavors |
Array of strings |
参数解释：资源规格支持的作业类型列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：资源规格实例的GPU卡类型。 取值范围：不涉及。 |
|
size |
String |
参数解释：资源规格实例的GPU卡数量。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：资源规格实例的NPU卡类型。 取值范围：不涉及。 |
|
size |
String |
参数解释：资源规格实例的NPU卡数量。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
volumeType |
String |
参数解释：磁盘类型，具体内容可参考磁盘类型及性能介绍。 取值范围：可选值如下：
|
|
size |
String |
参数解释：磁盘大小，单位为Gi。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
phase |
Map<String,String> |
参数解释：资源规格的容量状态，格式为key/value键值对。其中，key为az编码，value为对应az资源的状态，可选值如下：
|
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
请求示例
查询资源规格列表。
GET https://{endpoint}/v1/{project_id}/resourceflavors
{ }
响应示例
状态码：200
OK。
{
"kind" : "ResourceFlavorList",
"apiVersion" : "v1",
"metadata" : { },
"items" : [ {
"kind" : "ResourceFlavor",
"apiVersion" : "v1",
"metadata" : {
"name" : "modelarts.vm.cpu8u32g",
"labels" : { }
},
"spec" : {
"cpuArch" : "x86",
"cpu" : "8",
"memory" : "32Gi",
"type" : "Dedicate",
"billingCode" : "modelarts.vm.cpu.8ud",
"billingModes" : [ 0 ]
},
"status" : {
"phase" : {
"cn-north-7a" : "soldout",
"cn-north-7b" : "soldout",
"cn-north-7c" : "normal"
}
}
} ]
}
状态码：401
Authorization failed.
{
"error_code" : "ModelArts.50001000",
"error_msg" : "token is invalid"
}
状态码：404
Not found.
{
"error_code" : "ModelArts.50005101",
"error_msg" : "Resourceflavor not found."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
401 |
Authorization failed. |
|
404 |
Not found. |
错误码
请参见错误码。
