Querying Flavors Available for a Notebook Instance

Function

This API is used to query the flavors available for a notebook instance.

Constraints

None

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}/notebooks/{id}/flavors

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
id	Yes	String	Notebook instance ID.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page. (No limit by default)
offset	No	Integer	Start offset of the records on each page

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
current	Integer	Current page
data	Array of NotebookFlavor objects	Pagination data
flavors	Array of NotebookFlavor objects	Data
pages	Integer	Total number of pages
size	Integer	Number of records on each page
total	Long	Total number of records

Table 4 NotebookFlavor

Parameter	Type	Description
arch	String	Architecture type. Options: X86_64 AARCH64
ascend	AscendInfo object	NPU information
billing	BillingInfo object	CDR information
category	String	Processor type. Options: CPU GPU
description	String	Specification description
feature	String	Flavor type. Options: DEFAULT: CodeLab NOTEBOOK: notebook
free	Boolean	Free flavor or not
gpu	GPUInfo object	GPU information
id	String	Flavor ID
memory	Long	Memory size
name	String	Flavor name
sold_out	Boolean	Whether resources are sufficient. true: Resources are insufficient. false: Resources are sufficient.
storages	Array of strings	Storage type. Options: EVS EFS
vcpus	Integer	Number of vCPUs

Table 5 AscendInfo

Parameter	Type	Description
npu	Integer	Number of NPUs
npu_memory	String	NPU memory
type	String	NPU type

Table 6 BillingInfo

Parameter	Type	Description
code	String	Billing code
unit_num	Integer	Billing unit

Table 7 GPUInfo

Parameter	Type	Description
gpu	Integer	Number of GPUs
gpu_memory	String	GPU memory
type	String	GPU type

Example Requests

None

Example Responses

Status code: 200

OK

{
  "current" : 1,
  "data" : [ {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "32",
      "npu" : 2,
      "type" : "ascend-d910"
    },
    "billing" : {
      "code" : "modelarts.kat1.xlarge",
      "unit_num" : 2
    },
    "category" : "ASCEND",
    "description" : "The Ascend specification is suitable for deep learning code running and debugging",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.bm.d910.xlarge.2",
    "memory" : 201326592,
    "name" : "Ascend: 2*Ascend 910|CPU: 48vCPUs 192GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 48
  }, {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "128",
      "npu" : 8,
      "type" : "ascend-d910"
    },
    "billing" : {
      "code" : "modelarts.kat1.8xlarge",
      "unit_num" : 1
    },
    "category" : "ASCEND",
    "description" : "The Ascend specification is suitable for deep learning code running and debugging",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.bm.d910.xlarge.8",
    "memory" : 805306368,
    "name" : "Ascend: 8*Ascend 910|CPU: 192vCPUs 768GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 192
  } ],
  "flavors" : [ {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "32",
      "npu" : 2,
      "type" : "ascend-d910"
    },
    "billing" : {
      "code" : "modelarts.kat1.xlarge",
      "unit_num" : 2
    },
    "category" : "ASCEND",
    "description" : "The Ascend specification is suitable for deep learning code running and debugging",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.bm.d910.xlarge.2",
    "memory" : 201326592,
    "name" : "Ascend: 2*Ascend 910|CPU: 48vCPUs 192GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 48
  }, {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "128",
      "npu" : 8,
      "type" : "ascend-d910"
    },
    "billing" : {
      "code" : "modelarts.kat1.8xlarge",
      "unit_num" : 1
    },
    "category" : "ASCEND",
    "description" : "The Ascend specification is suitable for deep learning code running and debugging",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.bm.d910.xlarge.8",
    "memory" : 805306368,
    "name" : "Ascend: 8*Ascend 910|CPU: 192vCPUs 768GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 192
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

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