Help Center/ ModelArts/ API Reference/ DevEnviron Management/ Querying Flavors Available for a Notebook Instance

Updated on 2024-06-13 GMT+08:00

View PDF

Querying Flavors Available for a Notebook Instance

Function

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

Constraints

None

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	List of specifications that can be switched.
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	Specification type. The options are as follows: DEFAULT: CodeLab specification. NOTEBOOK: Notebook specifications.
free	Boolean	Specifies whether the flavor is free of charge.
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: EFS EVS
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

GET https://{endpoint}/v1/{project_id}/notebooks/{id}/flavors

Example Responses

Status code: 200

{
  "current" : 1,
  "data" : [ {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "32",
      "npu" : 2,
      "type" : "ascend-snt9"
    },
    "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.snt9.xlarge.2",
    "memory" : 201326592,
    "name" : "Ascend: 2*Ascend snt9|CPU: 48vCPUs 192GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 48
  }, {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "128",
      "npu" : 8,
      "type" : "ascend-snt9"
    },
    "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.snt9.xlarge.8",
    "memory" : 805306368,
    "name" : "Ascend: 8*Ascend snt9|CPU: 192vCPUs 768GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 192
  } ],
  "flavors" : [ {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "32",
      "npu" : 2,
      "type" : "ascend-snt9"
    },
    "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.snt9.xlarge.2",
    "memory" : 201326592,
    "name" : "Ascend: 2*Ascend snt9|CPU: 48vCPUs 192GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 48
  }, {
    "arch" : "aarch64",
    "ascend" : {
      "npu_memory" : "128",
      "npu" : 8,
      "type" : "ascend-snt9"
    },
    "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.snt9.xlarge.8",
    "memory" : 805306368,
    "name" : "Ascend: 8*Ascend snt9|CPU: 192vCPUs 768GB",
    "sold_out" : false,
    "storages" : [ "EFS" ],
    "vcpus" : 192
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}