更新时间:2024-05-30 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

分页查询时上一页位置。

labelSelector

String

标签筛选。

limit

Integer

分页数目。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本。可选值如下:

  • v1

kind

String

资源类型。可选值如下:

  • ResourceFlavorList:资源规格列表

metadata

metadata object

资源规格列表metadata信息。

items

Array of ResourceFlavor objects

资源规格列表。

表4 metadata

参数

参数类型

描述

continue

String

分页查询时,下一次查询位置。

remainingItemCount

Integer

剩余资源个数。

表5 ResourceFlavor

参数

参数类型

描述

apiVersion

String

API版本。可选值如下:

  • v1

kind

String

资源类型。可选值如下:

  • ResourceFlavor:资源规格

metadata

metadata object

资源规格的metadata信息。

spec

ResourceFlavorSpec object

资源规格的描述信息。

status

ResourceFlavorStatus object

资源规格的状态信息。

表6 metadata

参数

参数类型

描述

name

String

资源规格名称。

labels

ResourceFlavorLabel object

资源规格的标签信息。

表7 ResourceFlavorLabel

参数

参数类型

描述

os.modelarts/scope

String

资源规格对应的作业类型。

表8 ResourceFlavorSpec

参数

参数类型

描述

type

String

资源规格类型。可选值如下:

  • Dedicate:物理资源

cpuArch

String

计算机架构。可选值如下:

  • x86:x86架构

  • arm64:ARM架构

cpu

String

CPU核心数量。

memory

String

内存大小,单位为Gi。

gpu

gpu object

GPU信息。

npu

npu object

NPU信息。

dataVolume

Array of dataVolume objects

数据盘列表。

billingModes

Array of integers

资源规格支持的计费模式。可选值如下:

  • 0:按需计费

  • 1:包周期计费

billingCode

String

资源规格编码。用来对应运营平台的上架的商品。

jobFlavors

Array of strings

资源规格支持的作业类型列表。

表9 gpu

参数

参数类型

描述

type

String

GPU卡类型。

size

String

GPU卡数量。

表10 npu

参数

参数类型

描述

type

String

NPU卡类型。

size

String

NPU卡数量。

表11 dataVolume

参数

参数类型

描述

volumeType

String

磁盘类型。可选值如下:

  • SSD:超高IO硬盘

  • GPSSD:通用型SSD

  • SAS:高IO硬盘

  • SATA:普通硬盘

size

String

磁盘大小,单位为Gi。

表12 ResourceFlavorStatus

参数

参数类型

描述

phase

Map<String,String>

资源规格在各AZ的状态。值内容为:(AZ,Status)。Status可选值如下:

  • normal:正常

  • soldout:售罄

状态码: 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

状态码: 404

表14 响应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.

错误码

请参见错误码