更新时间:2025-08-19 GMT+08:00

查询资源规格列表

功能介绍

查询资源规格列表。

调试

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

URI

GET /v1/{project_id}/resourceflavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID,获取方法请参见获取项目ID和名称

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

continue

String

参数解释:分页查询的偏移标志。

约束限制:不涉及。

取值范围:取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。

默认取值:不涉及。

limit

Integer

参数解释:分页单次查询返回的资源数量。

约束限制:不涉及。

取值范围:0 - 500。

默认取值:500。

labelSelector

String

参数解释:标签筛选查询。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

参数解释:资源的API版本。

取值范围:可选值如下:

  • v1:当前资源版本为v1

kind

String

参数解释:资源的类型。

取值范围:可选值如下:

  • ResourceFlavorList:资源规格列表

metadata

metadata object

参数解释:资源规格列表的元信息。

取值范围:不涉及。

items

Array of ResourceFlavor objects

参数解释:资源规格列表。

取值范围:不涉及。

表4 metadata

参数

参数类型

描述

continue

String

参数解释:分页查询的偏移标志。

约束限制:可选。

取值范围:取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。

默认取值:不涉及。

remainingItemCount

Integer

参数解释:分页查询中剩余资源的数量。

默认取值:不涉及。

表5 ResourceFlavor

参数

参数类型

描述

apiVersion

String

参数解释:资源的API版本。

取值范围:可选值如下:

  • v1:当前资源版本为v1

kind

String

参数解释:资源的类型。

取值范围:可选值如下:

  • ResourceFlavor:资源规格

metadata

metadata object

参数解释:资源规格的元信息。

取值范围:不涉及。

spec

ResourceFlavorSpec object

参数解释:资源规格的规格信息。

取值范围:不涉及。

status

ResourceFlavorStatus object

参数解释:资源规格的状态信息。

取值范围:不涉及。

表6 metadata

参数

参数类型

描述

name

String

参数解释:资源规格的ID。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

labels

ResourceFlavorLabel object

参数解释:资源规格的标签信息。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

annotations

ResourceFlavorAnnotation object

参数解释:资源规格的注释信息。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表7 ResourceFlavorLabel

参数

参数类型

描述

os.modelarts/scope

String

参数解释:资源规格支持作业类型,以“.”分割。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表8 ResourceFlavorAnnotation

参数

参数类型

描述

os.modelarts.flavor/image.filter

String

参数解释:资源规格支持的私有镜像的过滤条件。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表9 ResourceFlavorSpec

参数

参数类型

描述

type

String

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

约束限制:不涉及。

取值范围:可选值如下:

  • Dedicate:物理资源规格。物理资源规格可以创建节点资源。

默认取值:不涉及。

cpuArch

String

参数解释:资源规格实例的计算架构。

约束限制:不涉及。

取值范围:可选值如下:

  • x86:x86架构。

  • arm64:ARM架构。

默认取值:不涉及。

cpu

String

参数解释:资源规格实例的CPU核心数量。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

memory

String

参数解释:资源规格实例的内存大小。以Gi为单位。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

gpu

gpu object

参数解释:资源规格实例的GPU资源信息。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

npu

npu object

参数解释:资源规格实例的GPU资源信息。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

dataVolume

Array of dataVolume objects

参数解释:资源规格实例的存储资源信息。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

billingModes

Array of integers

参数解释:资源规格支持的计费模式。

约束限制:不涉及。

取值范围:可选值如下:

  • 0:按需计费。

  • 1:包周期计费。

默认取值:不涉及。

billingCode

String

参数解释:资源规格计费码。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

jobFlavors

Array of strings

参数解释:资源规格支持的作业类型列表。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表10 gpu

参数

参数类型

描述

type

String

参数解释:资源规格实例的GPU卡类型。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

size

String

参数解释:资源规格实例的GPU卡数量。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表11 npu

参数

参数类型

描述

type

String

参数解释:资源规格实例的NPU卡类型。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

size

String

参数解释:资源规格实例的NPU卡数量。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表12 dataVolume

参数

参数类型

描述

volumeType

String

参数解释:磁盘类型。

约束限制:不涉及。

取值范围:可选值如下:

  • SSD:超高IO硬盘

  • GPSSD:通用型SSD

  • SAS:高IO硬盘

默认取值:不涉及。

size

String

参数解释:磁盘大小,单位为Gi。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表13 ResourceFlavorStatus

参数

参数类型

描述

phase

Map<String,String>

参数解释:资源规格的容量状态,格式为key/value键值对。其中,key为az编码,value为对应az资源的状态,可选值如下:

  • normal:正常。

  • soldout:售罄

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

状态码:401

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

参数解释:具体错误信息。

取值范围:不涉及。

状态码:404

表15 响应Body参数

参数

参数类型

描述

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.

错误码

请参见错误码