Help Center> ModelArts> API Reference> Resource Management> Obtaining a Resource Pool

Updated on 2024-04-30 GMT+08:00

View PDF

Obtaining a Resource Pool

Function

This API is used to obtain details about a specified resource pool.

Debugging

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

URI

GET /v2/{project_id}/pools/{pool_name}

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-ModelArts-User-ID	No	String	Tenant ID. If there is a tenant ID, it will be used for workspace authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
apiVersion	String	API version. The options are as follows: v2
kind	String	Resource type. The options are as follows: Pool: resource pool
metadata	PoolMetadata object	Specifies the metadata of the resource pool.
spec	PoolSpecModel object	Expected information about a resource pool.
status	PoolStatus object	Status of a resource pool.

**Table 4** PoolMetadata
Parameter	Type	Description
name	String	Automatically generated resource pool name, which is equivalent to pool ID.
creationTimestamp	String	Timestamp, for example, 2021-11-01T03:49:41Z.
labels	PoolMetaLabels object	Resource pool labels.
annotations	PoolMetaAnnotations object	Resource pool annotations.

**Table 5** PoolMetaLabels
Parameter	Type	Description
os.modelarts/workspace.id	String	Workspace ID.
os.modelarts/name	String	Specified resource pool name.
os.modelarts/resource.id	String	ID of the primary resource in the resource pool, which is usually provided for CBC.
os.modelarts/tenant.domain.id	String	ID of the tenant corresponding to the resource pool, which records the tenant account where the resource pool is created

**Table 6** PoolMetaAnnotations
Parameter	Type	Description
os.modelarts/description	String	Description of a resource pool.
os.modelarts/billing.mode	String	Billing mode. The options are as follows: 0: Pay per use 1: Yearly/Monthly
os.modelarts/period.num	String	Subscription period on a yearly/monthly basis, for example, 2.
os.modelarts/period.type	String	Yearly/monthly subscription. Options: 2: month 3: year 4: hour
os.modelarts/auto.renew	String	Whether to automatically renew the subscription. Options: 0: auto-renewal disabled (default value) 1: auto-renewal enabled
os.modelarts/promotion.info	String	Discount selected in CBC.
os.modelarts/service.console.url	String	URL of the page displayed after the subscription order is paid.
os.modelarts/order.id	String	Order ID, which is mandatory when creating a yearly/monthly resource pool or changing its billing mode.
os.modelarts/flavor.resource.ids	String	Specifies the resource ID corresponding to each flavor, which is used for interaction with CBC.
os.modelarts/tms.tags	String	TMS tag specified by the user during creation.

**Table 7** PoolSpecModel
Parameter	Type	Description
type	String	Resource pool type. The options are as follows: Dedicate: physical resource pool, independent network, network streamlining, customized driver, and customized job type
scope	Array of strings	Job type supported by the resource pool. Select at least one type. You can select all physical resource pools. The options are as follows: Train: training job Infer: inference job Notebook: Notebook job
resources	Array of resources objects	List of resource specifications in the resource pool, including resource specifications and the number of resources of the corresponding specifications.
network	network object	Specifies the network parameters of the resource pool. This parameter is mandatory for physical resource pools.
jobFlavors	Array of strings	List of job specifications supported by the resource pool. The content is the job specification name.
driver	PoolDriver object	Indicates the driver information of the resource pool.
controlMode	Integer	Restriction status of a resource pool. The options are as follows: 0: not restricted 1: The change to yearly/monthly is restricted. 2: The specification change is restricted. 4: The service is restricted. 8: frozen 16: frozen by the public security department (cannot be unsubscribed) In addition, the status can be accumulated. For example, 9 indicates that the billing mode is restricted and frozen.

**Table 8** resources
Parameter	Type	Description
flavor	String	Resource specifications, for example, modelarts.vm.gpu.t4u8.
count	Integer	Number of resources of the corresponding specifications.
azs	Array of PoolNodeAz objects	Specifies the AZ list.

**Table 9** PoolNodeAz
Parameter	Type	Description
az	String	AZ name
count	Integer	Number of nodes for expanding the capacity of a specified AZ.

**Table 10** network
Parameter	Type	Description
name	String	Specifies the network name. When a user interface creates a network by specifying the network name, the system automatically creates a subnet. Users cannot create a subnet. By default, the system is created under the first subnet.

**Table 11** PoolDriver
Parameter	Type	Description
gpuVersion	String	GPU driver version. This parameter is mandatory when the physical resource pool contains GPU specifications, for example, 440.33.
npuVersion	String	NPU driver version. This parameter is mandatory when the physical resource pool contains ascend specifications, for example, C78.
updateStrategy	String	Indicates the driver upgrade policy. The options are as follows: force: forcible upgrade. The node driver is upgraded immediately, which may affect the running jobs on the node. idle: secure upgrade. The driver is upgraded when no job is running on the node.

**Table 12** PoolStatus
Parameter	Type	Description
phase	String	Resource pool cluster status. The options are as follows: Creating: It is being created. Running: It is running. Abnormal: The resource pool malfunctions. Deleting: It is being deleted. Error: An error occurred in the resource pool.
message	String	Message indicating that the resource pool is in the current state.
resources	resources object	Number of resources in different states in a resource pool.
scope	Array of scope objects	Service status of a resource pool.
driver	driver object	Resource pool driver.
parent	String	Name of the parent node in the resource pool. This parameter is left blank for physical pools.
root	String	Name of the root node in the resource pool. For a physical pool, set this parameter to its own name.

**Table 13** resources
Parameter	Type	Description
creating	PoolResourceFlavorCount object	Number of resources that are being created.
available	PoolResourceFlavorCount object	Number of available resources.
abnormal	PoolResourceFlavorCount object	Number of unavailable resources.
deleting	PoolResourceFlavorCount object	Number of resources that are being deleted.

**Table 14** PoolResourceFlavorCount
Parameter	Type	Description
flavor	String	Resource specification name, for example, modelarts.vm.gpu.t4u8.
count	Integer	Indicates the guaranteed usage of specifications.
maxCount	Integer	Elastic usage of the resource specification. The value of this parameter is the same as that of count in the physical pool.
azs	Array of azs objects	Number of AZs where the resource is located.

**Table 15** azs
Parameter	Type	Description
az	String	Name of an AZ.
count	Integer	Resources of an AZ.

**Table 16** scope
Parameter	Type	Description
scopeType	String	Service type. The options are as follows: Train: training task Infer: inference task Notebook: Notebook job
state	String	Service status. Options: Enabling: The service is being enabled. Enabled: The service is enabled. Disabling: The service is being disabled. Disabled: The service is disabled.

**Table 17** driver
Parameter	Type	Description
gpu	PoolDriverStatus object	GPU driver.
npu	PoolDriverStatus object	NPU driver.

**Table 18** PoolDriverStatus
Parameter	Type	Description
version	String	Indicates the current driver version.
state	String	Indicates the current driver status. Options: Creating: The gateway is being created. Upgrading: The upgrade is in progress. Running Abnormal: abnormal

Status code: 404

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Error codes of ModelArts
error_msg	String	Error message

Example Requests

Obtain details about a resource pool.

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}

{ }

Example Responses

Status code: 200

{
  "kind" : "Pool",
  "apiVersion" : "v2",
  "metadata" : {
    "name" : "auto-pool-os-86c13962597848eeb29c5861153a391f",
    "creationTimestamp" : "2022-09-16T03:10:40Z",
    "labels" : {
      "os.modelarts/name" : "auto-pool-os",
      "os.modelarts/workspace.id" : "0",
      "os.modelarts/resource.id" : "maos-auto-pool-os-72w8d"
    },
    "annotations" : {
      "os.modelarts/description" : "",
      "os.modelarts/billing.mode" : "0"
    }
  },
  "spec" : {
    "type" : "Dedicate",
    "scope" : [ "Train", "Infer" ],
    "resources" : [ {
      "flavor" : "modelarts.vm.cpu.4ud",
      "count" : 2
    } ],
    "network" : {
      "name" : "network-maos-86c13962597848eeb29c5861153a391f"
    }
  },
  "status" : {
    "phase" : "Running",
    "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f",
    "scope" : [ {
      "scopeType" : "Train",
      "state" : "Enabled"
    }, {
      "scopeType" : "Infer",
      "state" : "Enabled"
    } ],
    "resources" : {
      "available" : [ {
        "flavor" : "modelarts.vm.cpu.4ud",
        "count" : 2,
        "azs" : [ {
          "az" : "cn-north-7c",
          "count" : 2
        } ]
      } ]
    }
  }
}

Status code: 404

Not found.

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "pool not found"
}

Status Codes

Status Code	Description
200	OK
404	Not found.

Error Codes

See Error Codes.

Parent topic: Resource Management

Previous topic: Obtaining Resource Pools

Next topic: Deleting a Resource Pool

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot