Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Obtaining Resource Pools

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

Function

This API is used to obtain resource pools.

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspaceId

No

String

Workspace ID. The default value is 0.

labelSelector

No

String

Filter by label.

status

No

String

Resource pool status. The options are as follows:

  • created: indicates the resource pool that is successfully created.

  • failed: The resource pool fails to be created. The records of the resource pool that fails to be created are retained for three days.

  • creating: The resource pool is being created. If this parameter is left blank, valid resource pools are returned, including those being created and those successfully created.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

apiVersion

String

API version. Options:

  • v2

kind

String

Resource type. Options:

  • PoolList: resource pools

items

Array of PoolModel objects

Resource pools.

Table 4 PoolModel

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 5 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 6 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 7 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 8 PoolSpecModel

Parameter

Type

Description

type

String

Resource pool type. The options are as follows:

  • Dedicate: physical resource pool, which uses a separate network and supports network connection, custom drivers, and custom job types.

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: Changing to the yearly/monthly billing is restricted.

  • 2: Modifying specifications is restricted.

  • 4: The service is restricted.

  • 8: frozen

  • 16: The resource pool is frozen by the public security department (cannot be unsubscribed). In addition, multiple statuses are allowed. For example, a resource pool is in state 9, indicating that it is frozen and changing its billing mode to yearly/monthly is restricted.

Table 9 resources

Parameter

Type

Description

flavor

String

Resource flavor, for example, modelarts.vm.gpu.tnt004.

count

Integer

Number of resources of the corresponding specifications.

azs

Array of PoolNodeAz objects

Specifies the AZ list.

Table 10 PoolNodeAz

Parameter

Type

Description

az

String

AZ name

count

Integer

Number of nodes for expanding the capacity of a specified AZ.

Table 11 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 12 PoolDriver

Parameter

Type

Description

gpuVersion

String

GPU driver version. This parameter is available when GPUs are used in a physical resource pool. For example, the GPU driver version is 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 13 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 14 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 15 PoolResourceFlavorCount

Parameter

Type

Description

flavor

String

Resource flavor name, for example, modelarts.vm.gpu.tnt004.

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 16 azs

Parameter

Type

Description

az

String

Name of an AZ.

count

Integer

Resources of an AZ.

Table 17 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 18 driver

Parameter

Type

Description

gpu

PoolDriverStatus object

GPU driver.

npu

PoolDriverStatus object

NPU driver.

Table 19 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

Example Requests

Obtain resource pools.

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

{ }

Example Responses

Status code: 200

OK

{
  "kind" : "PoolList",
  "apiVersion" : "v2",
  "items" : [ {
    "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 Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback