Querying Details About a Managed Resource Pool

Function

This API allows you to query details about a managed resource pool by specifying the resource pool ID, including the instance ID, name, flavor, instance status, and accessible URL of the instance. This function is applicable to users who need to monitor or manage cloud resources. Before using this API, ensure that users have the access permission and the correct resource pool ID. After the execution is successful, you can obtain the required instance details for further resource management and configuration. If the resource pool ID is invalid or the user does not have the access permission, the API returns an error message, for example, "404 Not Found" or "401 Unauthorized".

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

modelarts:pool:get

Read

pool *

g:ResourceTag/<tag-key>

-

-

-

g:EnterpriseProjectId

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
modelarts:pool:get	Read	pool *	g:ResourceTag/<tag-key>	-	-
-	g:EnterpriseProjectId

URI

GET /v2/{project_id}/services/clusters/{id}

**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 N/A Range Project ID. Default Value N/A
id	Yes	String	Definition Resource pool ID. Services in a specified resource pool are queried. By default, no resource pool is filtered. You can obtain the value by querying the resource pool list. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A
X-User-Token	No	String	Definition User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
workspace_id	String	Definition Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value. Range N/A
logic_cluster_id	String	Definition Resource pool CCE ID. Range N/A
status	String	Definition Current status of resources. Range ACTIVE: enabled. PENDING: to be processed. INITIALIZING: being initialized. INITIALIZE_FAILED: initialization failed. DELETED: deleted. DELETING: being deleted. DELETE_FAILED: deletion failed. MIGRATING: being migrated.
pool_id	String	Definition Dedicated resource pool ID. Range N/A
type	String	Definition Dedicated pool type. Range MANAGED: public MANAGED_ROMA: public DEDICATED: dedicated DEDICATED_ROMA: dedicated
resource_categories	Array of strings	Definition Agent pool type.
project_id	String	Definition Project ID. For details, see Obtaining a Project ID and Name. Range N/A
create_at	Long	Definition Time when the resource pool is enabled, in UTC milliseconds. Range N/A
update_at	Long	Definition Time when the resource pool was last updated, in UTC milliseconds. Range N/A
flavors	Array of NotebookFlavor objects	Definition Specifications supported by the current dedicated pool.

**Table 4** NotebookFlavor
Parameter	Type	Description
arch	String	Definition Architecture type. Range x86_64 aarch64
ascend	AscendInfo object	Definition NPU information.
billing	BillingInfo object	Definition Bill information.
category	String	Definition Processor type. Range CPU GPU ASCEND
description	String	Definition Specification description. Range N/A
feature	String	Definition Flavor type. Range DEFAULT: CodeLab NOTEBOOK: notebook
free	Boolean	Definition Specifies whether the flavor is free. Range true: free flavor. false: paid flavor.
gpu	GPUInfo object	Definition GPU information. Range N/A
id	String	Definition Specification ID. Range N/A
memory	Long	Definition Memory size. Range N/A
name	String	Definition Flavor name. Range N/A
sold_out	Boolean	Definition Indicates whether resources are sufficient. Range true: Resources are insufficient. false: Resources are sufficient.
storages	Array of strings	Definition Storage type.
vcpus	Integer	Definition CPU cores. Range N/A
evs_max_size	String	Definition Specifies the maximum capacity of an EVS disk. Range N/A

**Table 5** 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
ai_core	String	Definition Number of AI cores in the allocated specifications. Range N/A
ai_cpu	String	Definition Number of AI CPUs in the allocated specifications. Range N/A

**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** GPUInfo
Parameter	Type	Description
gpu	Integer	Definition Number of GPUs. Range N/A
gpu_memory	String	Definition GPU memory. Range N/A
type	String	Definition GPU type. Range N/A

Example Requests

Obtain details about a managed resource pool by specifying the resource pool ID.

https://{endpoint}/v2/{project_id}/services/clusters/{id}

{
  "id" : "123e4567-e89b-12d3-a456-426655440000"
}

Example Responses

Status code: 200

The detailed information about the managed cluster is obtained.

{
  "logic_cluster_id" : "df7ab421-4c12-4032-a344-b2e41aa1a962",
  "status" : "ACTIVE",
  "pool_id" : "pool-id***example",
  "type" : "DEDICATED",
  "resource_categories" : [ "CPU" ],
  "flavors" : [ {
    "arch" : "x86_64",
    "billing" : {
      "unit_num" : 0
    },
    "category" : "CPU",
    "description" : "General-purpose CPU specifications, ideal for data exploration and algorithm discovery",
    "evs_max_size" : "4096",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.vm.cpu.2u.8g",
    "memory" : 8388608,
    "name" : "CPU: 2vCPUs 8GB",
    "sold_out" : false,
    "storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
    "vcpus" : 2
  }, {
    "arch" : "x86_64",
    "billing" : {
      "code" : "modelarts.vm.cpu.4u",
      "unit_num" : 1
    },
    "category" : "CPU",
    "description" : "General-purpose Intel CPU specifications, ideal for data exploration and algorithm discovery.",
    "evs_max_size" : "4096",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.vm.cpu.4u",
    "memory" : 16777216,
    "name" : "CPU: 4vCPUs 16GB",
    "sold_out" : false,
    "storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
    "vcpus" : 4
  }, {
    "arch" : "x86_64",
    "billing" : {
      "code" : "modelarts.vm.cpu.8u",
      "unit_num" : 1
    },
    "category" : "CPU",
    "description" : "General computing-plus Intel CPU specifications, ideal for compute-intensive applications.",
    "evs_max_size" : "4096",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.vm.cpu.8u",
    "memory" : 33554432,
    "name" : "CPU: 8vCPUs 32GB",
    "sold_out" : false,
    "storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
    "vcpus" : 8
  } ],
  "workspace_id" : "0",
  "create_at" : 1721795441423,
  "update_at" : 1724767716067,
  "project_id" : "06024304be00d***example"
}