Obtaining Details About All Notebook Resource Pool Instances

Function

This API is used to obtain details about all notebook resource pool instances associated with a user. This API is used when you need to select a resource pool when creating a notebook instance. Before using this API, ensure that you have registered and logged in to the system and have the permission to view resource pool instances. After the API is called, the API returns a list of detailed information about all resource pool instances, including the instance name, status, and node specifications. If you have not logged in to the system, do not have the required permission to access the resource pool, or an internal error occurs in the system, the API returns an error message, for example, unauthorized access, service unavailable, or internal error.

Debugging

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

URI

GET /v1/{project_id}/authoring/clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition: Resource pool type. Constraints: N/A Range MANAGED: public pool DEDICATED: dedicated pool Default Value: N/A
workspace_id	No	String	Definition: Workspace ID. . Constraints: There must be a workspace in use. Range: N/A Default Value: 0
limit	No	Integer	Definition: Number of instances displayed on each page. Constraints: N/A Range: greater than or equal to 0. Default Value: 1000
offset	No	Integer	Definition: Offset of data records. Constraints: N/A Range: greater than or equal to 0. Default Value: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
current	Integer	Definition: Current page number. Range: Positive integers.
data	Array of ClusterResponse objects	Definition: Notebook instance data.
pages	Integer	Definition: Total number of pages. Range: Positive integers.
size	Integer	Definition: Number of records on each page. Range: Positive integers.
total	Long	Definition: Total number of records. Range: Non-negative integers.

**Table 4** ClusterResponse
Parameter	Type	Description
logic_cluster_id	String	Definition: Logical resource pool ID. Range: N/A
status	String	Definition: Resource pool status. Range: PENDING INITIALIZING INITIALIZE_FAILED ACTIVE DELETING DELETED DELETE_FAILED MIGRATING
pool_id	String	Definition: Resource pool ID. Range: N/A
type	String	Definition: Resource pool type. Range: MANAGED: public pool DEDICATED: dedicated pool
resource_categories	String	Definition: Resource type. Range: GPU CPU ASCEND
workspace_id	String	Definition: Workspace ID. For details about how to obtain the value, see Obtaining Workspaces. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A
create_at	String	Definition: UTC time when the instance is created, accurate to millisecond. Range: N/A
update_at	String	Definition: Time (UTC) when the instance was last updated, accurate to millisecond. Range: N/A
project_id	String	Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A
domain_id	String	Definition: Account ID. Range: N/A
flavors	Array of Flavor objects	Definition: Resource pool flavors.

**Table 5** Flavor
Parameter	Type	Description
arch	String	Definition: Hardware architecture type. Range: x86_64: x86 architecture aarch64: Arm architecture
billing	BillingInfo object	Definition: CDR information.
category	String	Definition: Processor type. Range: CPU GPU ASCEND
description	String	Definition: Flavor description. Range: N/A
evs_max_size	String	Definition: Maximum size (GB) of EVS storage that can be created. Range: N/A
evs_sku_code	String	Definition: SKU code of EVS storage. Range: N/A
feature	String	Definition: Flavor type. Range: DEFAULT: CodeLab NOTEBOOK: notebook
free	Boolean	Definition: Indicates whether a free flavor is used. Range: Boolean true: free flavor. false: non-free flavor.
grow_support_type	String	Definition: Site type. Range: COMMON: supported on both the Chinese mainland and International sites NATIONAL: supported only on the Chinese mainland site INTERNATIONAL: supported only on the International site NONE: supported on neither the Chinese mainland nor International sites
id	String	Definition: Flavor ID. Range: N/A
memory	String	Definition: Memory size. Range: N/A
name	String	Definition: Flavor name. Range: N/A
sold_out	Boolean	Definition: Indicates whether the flavor is sold out. Range: Boolean true: The flavor is sold out. false: The flavor is not sold out.
storages	Array of strings	Definition: Storage type supported by the flavor. Range: EVS OBS: Object Storage Service OBSFS: parallel file system EFS: SFS Turbo
vcpus	Integer	Definition: Number of CPU cores. Range: N/A
gpu	GPUsInfo object	Definition: GPU specifications when the processor type is GPU.
ascend	AscendInfo object	Definition: Ascend specifications when the processor type is ASCEND.

**Table 6** BillingInfo
Parameter	Type	Description
code	String	Definition: Billing code. Range: N/A
unit_num	Integer	Definition: Billing unit. Range: N/A

**Table 7** GPUsInfo
Parameter	Type	Description
type	String	Definition: GPU type. Range: N/A
gpu	Double	Definition: Number of GPUs. Range: N/A
gpu_memory	String	Definition: GPU memory. Range: N/A

**Table 8** AscendInfo
Parameter	Type	Description
npu	Integer	Definition: Number of NPUs. Range: N/A
npu_memory	String	Definition: NPU memory. Range: N/A
type	String	Definition: NPU type. Range: N/A

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

GET /v1/{project_id}/authoring/clusters

Example Responses

Status code: 200

Request succeeded.

{
  "current" : 0,
  "data" : [ {
    "logic_cluster_id" : "e393b479-bd29-4131-9d89-e8f5d98ea16c",
    "status" : "ACTIVE",
    "pool_id" : "pool-traintest-memarts-06024304be00d5092fbdc0013d201342",
    "type" : "DEDICATED",
    "resource_categories" : [ "CPU" ],
    "flavors" : [ {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.2u",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "General-purpose Intel CPU flavor, ideal for rapid data exploration and experiments.",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "INTERNATIONAL",
      "id" : "modelarts.vm.cpu.2u",
      "memory" : 8388608,
      "name" : "CPU: 2 vCPUs 8GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 2
    }, {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.4u",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "General-purpose Intel CPU flavor, ideal for rapid data exploration and experiments.",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "COMMON",
      "id" : "modelarts.vm.cpu.4u",
      "memory" : 16777216,
      "name" : "CPU: 4 vCPUs 16GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 4
    }, {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.8u.2xlarge.predefined",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "General computing-plus Intel CPU flavors, ideal for compute-intensive applications.",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "NONE",
      "id" : "modelarts.vm.cpu.8u.2xlarge.predefined",
      "memory" : 33554432,
      "name" : "CPU: 8 vCPUs 32GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 8
    } ],
    "workspace_id" : "0",
    "create_at" : 1737690370131,
    "update_at" : 1752722684027,
    "domain_id" : "06024304b180d5090fbac00141b6cae0",
    "project_id" : "06024304be00d5092fbdc0013d201342"
  } ],
  "pages" : 1,
  "size" : 200,
  "total" : 40
}