Obtaining Resource Specifications¶

Function¶

Obtain resource specifications.

Debugging¶

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI¶

GET /v1/{project_id}/resourceflavors

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
continue	No	String	Previous query location in pagination query.
labelSelector	No	String	Filter by label.
limit	No	Integer	Number of records on each page.

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
apiVersion	String	API version. Options: v1
kind	String	Resource type. Options: ResourceFlavorList: resource specifications
metadata	metadata object	Metadata of resource specifications.
items	Array of ResourceFlavor objects	Resource specifications.

**Table 4** metadata¶
Parameter	Type	Description
continue	String	Next query location in pagination query.
remainingItemCount	Integer	Remaining resources.

**Table 5** ResourceFlavor¶
Parameter	Type	Description
apiVersion	String	API version. Options: v1
kind	String	Resource type. Options: ResourceFlavor: resource specification
metadata	metadata object	Metadata of a resource specification.
spec	ResourceFlavorSpec object	Description of a resource specification.
status	ResourceFlavorStatus object	Status of a resource specification.

**Table 6** metadata¶
Parameter	Type	Description
name	String	Resource specification name.
labels	ResourceFlavorLabel object	Specifies the tag information of the resource flavor.

**Table 7** ResourceFlavorLabel¶
Parameter	Type	Description
os.modelarts/scope	String	Job type corresponding to the resource specification.

**Table 8** ResourceFlavorSpec¶
Parameter	Type	Description
type	String	Resource specification type. Options: Dedicate: physical resources Logical: logical resources
cpuArch	String	Computer architecture. Options: x86 arm64
cpu	String	Number of CPU cores.
memory	String	Memory size in GiB.
gpu	gpu object	GPU information.
npu	npu object	NPU information.
dataVolumes	Array of dataVolumes objects	Data disks
billingModes	Array of integers	Specifies the billing mode supported by the resource specifications. The options are as follows: 0: Pay per use 1: Yearly/Monthly
jobFlavors	Array of strings	Training job types supported by resource specifications.

**Table 9** gpu¶
Parameter	Type	Description
type	String	GPU type.
size	String	Number of GPUs

**Table 10** npu¶
Parameter	Type	Description
type	String	NPU type.
size	String	Number of NPUs.

**Table 11** dataVolumes¶
Parameter	Type	Description
volumeType	String	Disk type. The options are as follows: SSD: ultra-high I/O hard disk GPSSD: general-purpose SSD SAS: high I/O hard disk SATA: common hard disk
size	String	Disk size, in GiB

**Table 12** ResourceFlavorStatus¶
Parameter	Type	Description
phase	Map<String,String>	Sales status of a resource specification in each AZ. The value is (AZ, Status). Options for Status: normal: The specification is on-sales. soldout: The specification is sold out.

Status code: 401

**Table 13** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 14** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests¶

This API is used to obtain resource specifications.

GET https://{endpoint}/v1/{project_id}/resourceflavors

{ }

Example Responses¶

Status code: 200

{
  "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",
      "billingModes" : [ 0 ],
      "dataVolumes" : [ {
        "volumeType" : "SSD",
        "size" : "500Gi"
      } ]
    },
    "status" : {
      "phase" : {
        "cn-xxxxx-7a" : "soldout",
        "cn-xxxxx-7b" : "soldout",
        "cn-xxxxx-7c" : "normal"
      }
    }
  } ]
}

Status code: 401

Authorization failed.

{
  "error_code" : "ModelArts.50001000",
  "error_msg" : "token is invalid"
}

Status code: 404

Not found.

{
  "error_code" : "ModelArts.50005101",
  "error_msg" : "Resourceflavor not found."
}

Status Codes¶

Status Code	Description
200	OK
401	Authorization failed.
404	Not found.

Error Codes¶

See Error Codes.

last updated: 2024-11-14 08:44 UTC - commit: 3b80612feba1452e3d3adbec6770d8e1b5070820