Help Center/ ModelArts/ API Reference/ Resource Management/ Querying Details About a Single Node in a Resource Pool
Updated on 2026-06-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Details About a Single Node in a Resource Pool

Function

This API is used to obtain details about a single node in a specified resource pool. It is used when you need to view the node resource allocation and details such as the node type, status, configuration parameters, and associated services. Before using this API, ensure that the target resource pool exists and you have sufficient permissions to view it. In addition, you need to provide a valid resource pool ID as the input parameter. After this API is called, the system returns data of a single node in the resource pool. If the resource pool does not exist, the user permission is insufficient, or the input parameters are invalid, an error message, for example, "404 Resource pool not found" or "403 Permission denied", is returned.

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, no identity policy-based permission required for calling this API.

URI

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

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

pool_name

Yes

String

Definition: Resource pool ID. To obtain the value, see the metadata.name field in the resource pool details.

*Constraints: The value can contain 36 to 63 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed.

Range: N/A

Default Value: N/A

node_name

Yes

String

Definition: Node name. To obtain the value, see the metadata.name field in the node details.

Constraints: N/A Range: N/A

Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

apiVersion

String

Definition: API version of the resource.

Range:

  • v2: The current resource version is v2.

kind

String

Definition: Resource type.

Range:

  • Node: node

metadata

NodeMetadata object

Definition: Metadata of a node resource.

spec

NodeSpec object

Definition: Specifications of a node resource.

status

NodeStatus object

Definition: Status of a node resource.
Table 3 NodeMetadata

Parameter

Type

Description

name

String

Definition: Node name.

Range: N/A

creationTimestamp

String

Definition: Creation time.

Range: N/A

labels

NodeLabels object

Definition: Node labels.

annotations

NodeVOAnnotations object

Definition: Node annotations.
Table 4 NodeLabels

Parameter

Type

Description

os.modelarts.node/cluster

String

Definition: Name of the cluster where the node is located.

Range: N/A

os.modelarts.node/elastic.quota

String

Definition: Logical pool bound to the node.

Range: N/A

os.modelarts.node/nodepool

String

Definition: ID of the node pool where the node is located.

Range: N/A

os.modelarts.node/batch.uid

String

Definition: Batch creation ID.

Range: N/A

os.modelarts.node/batch.name

String

Definition: Batch creation name.

Range: N/A

os.modelarts.node/batch.type

String

Definition: Batch creation type.

Range

  • hyperinstance: supernode

os.modelarts.node/batch.count

String

Definition: Number of nodes created in batches.

Range: N/A

os.modelarts/resource.id

String

Definition: Node resource ID.

Range: N/A

os.modelarts/tenant.domain.id

String

Definition: Tenant ID of a node, which records the tenant account under which the node is created.

Range: N/A

os.modelarts/tenant.project.id

String

Definition: Project ID of a node, which records the project under which the node is created.

Range: N/A

os.modelarts/billing.status

String

Definition: Node billing status.

Range

  • 0: normal

  • 1: frozen

  • 2: deleted or terminated

os.modelarts.node/volcano.scheduler.cabinet-exclusive

String

Definition: Whether the node is exclusively occupied by a full-rack job. If yes, tha tag exists and its value is the ID of the exclusive training job.

Range: N/A

cce.kubectl.kubernetes.io/cabinet

String

Definition: IP address of the TOR switch where the node is located. Use hyphens (-) to separate multiple IP addresses of TOR switches.

Range: N/A

os.modelarts.node/underlying.instance.id

String

Definition: Instance ID of the underlying resources of the node, for example, the ECS instance ID of the supernode.

Range: N/A

os.modelarts.node/ha.redundant.enabled

String

Definition: Whether HA redundancy is enabled for the node.

Range

  • true: enabled

  • false: disabled

os.modelarts.node/nodepoolname

String

Definition: Name of the node pool where the node is located. The value can contain 2 to 50 characters and must start with a lowercase letter. It cannot end with a hyphen (-) or -default. Only lowercase letters, hyphens (-), and digits are allowed.

Range: N/A
Table 5 NodeVOAnnotations

Parameter

Type

Description

os.modelarts/npu-topology-placement

String

Definition: Topology of the NPU resource usage. The value is a 16-bit binary number, where the first bit from the right indicates PU 1. 1 indicates occupied, and 0 indicates idle. For example, if PUs 1 and 15 are occupied in a 16-PU server, the value is 0100000000000001. If PUs 1 and 7 are occupied in an 8-PU server, the returned value is 0000000001000001.

Constraints: N/A

Range: N/A

Default Value: N/A
Table 6 NodeSpec

Parameter

Type

Description

flavor

String

Definition: ID of node resource specifications.

Range: N/A.

os

Os object

Definition: OS image information.

hostNetwork

NodeNetwork object

Definition: Node network information.

rootVolume

VolumeVO object

Definition: System disk information.

dataVolumes

Array of VolumeVO objects

Definition: Data disk information.

extendParams

ResourceExtendParams object

Definition: Custom configuration.
Table 7 Os

Parameter

Type

Description

name

String

Definition: OS name and version, for example, EulorOS 2.5. This parameter can be left blank when a private image is specified.

Range: N/A.

imageId

String

Definition: OS image ID.

Range: N/A.

imageType

String

Definition: OS image type. This parameter must be specified when a private image is set. By default, the preset image is used. You do not need to specify this field.

Range:

  • private: private images

  • "": The preset image is used.

autoMatch

String

Definition: Automatic OS image matching configuration. If this parameter is set, the optimal image is automatically selected, and this parameter is automatically cleared.

Range: OS name and version, for example, EulorOS 2.5.
Table 8 NodeNetwork

Parameter

Type

Description

vpc

String

  • Definition: VPC ID.

Range: N/A.

subnet

String

Definition: Subnet ID.

Range: N/A.

securityGroups

Array of strings

Definition: Security group ID set.
Table 9 VolumeVO

Parameter

Type

Description

volumeType

String

Definition: Disk type..

Range:

  • SSD: Ultra-high I/O disk

  • GPSSD: General-purpose SSD

size

String

Definition: Disk size, in GiB.

Range: N/A.

count

Integer

Definition: Number of disks. If this parameter is not specified, the default value 1 is used.

Range: N/A.
Table 10 ResourceExtendParams

Parameter

Type

Description

dockerBaseSize

String

Definition: Container image space of a node.

Range:

  • Specified: The default value of dockerBaseSize ranges from 50 to 500. However, the actual value is restricted by the container data disk size of the node.

  • Unlimited: *dockerBaseSize="0, indicating that the container image space is not limited.

postInstall

String

Definition: Post-installation script. The entered value must be encoded using Base64.

Range: N/A.

runtime

String

Definition: Container runtime.

Range:

  • docker: Container runtime. It is the most commonly used container engine, which is used to create and manage container instances based on container images.

  • containerd: Industrial-grade container runtime. It focuses on container lifecycle management and is one of the core components at the bottom layer of Docker. It can also be deployed independently.

labelPolicyOnExistingNodes

String

Definition: Kubernetes label update policy of existing nodes. If the value is empty, the existing nodes are updated by default.

Range:

  • refresh: Update.

  • ignore: Do not update.

taintPolicyOnExistingNodes

String

Definition: Kubernetes taint update policy of existing nodes. If the value is empty, the existing nodes are updated by default.

Range:

  • refresh: Update.

  • ignore: Do not update.

tagPolicyOnExistingNodes

String

Definition: Resource tag update policy of existing nodes. If the value is empty, the existing nodes are updated by default.

Range:

  • refresh: Update.

  • ignore: Do not update.

XParameterPlaneSubnet

String

Definition: Subnet ID used for data transmission on the parameter plane between physical clusters. The value cannot be the same as the node subnet or container subnet.

Range: N/A.

nodePoolName

String

Definition: Name of the node pool specified by you. The value is a string of 2 to 50 characters, consisting of lowercase letters, hyphens (-), and digits. It must start with a lowercase letter and cannot end with a hyphen (-) or -default.

Range: N/A.
Table 11 NodeStatus

Parameter

Type

Description

phase

String

Definition: Status of a node.

Range:

  • Available: The node is available.

  • Creating: The node is being created.

  • Deleting: The node is being deleted.

  • Abnormal: The node is abnormal.

  • Checking: The node is performing a self-check.

az

String

Definition: AZ where a node is located.

Range: N/A

privateIp

String

Definition: IP address of a node.

Range: N/A

resources

NodeResource object

Definition: Resources of a node.

availableResources

NodeResource object

Definition: Available resources of a node.
Table 12 NodeResource

Parameter

Type

Description

cpu

String

Definition: Number of CPU cores on a node.

Range: N/A

memory

String

Definition: Memory size of a node, in GiB.

Range: N/A

nvidia.com/gpu

String

Definition: Number of GPUs on a node.

Range: N/A

huawei.com/ascend-snt3

String

Definition: Number of snt3 NPUs on a node.

Range: N/A

huawei.com/ascend-snt9

String

Definition: Number of snt9 NPUs on a node.

Range: N/A

Status code: 404

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

Query details about a single node in a resource pool.

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

{ }

Example Responses

Status code: 200

OK.

{
  "kind" : "Node",
  "apiVersion" : "v2",
  "metadata" : {
    "name" : "os-node-created-zlncn",
    "creationTimestamp" : "2022-09-16T05:32:44Z"
  },
  "spec" : {
    "flavor" : "modelarts.vm.cpu.4ud"
  },
  "status" : {
    "phase" : "Available",
    "az" : "xx-xxxx-xx",
    "privateIp" : "192.168.0.1",
    "resources" : {
      "cpu" : "3920m",
      "memory" : "6270Mi"
    },
    "availableResources" : {
      "cpu" : "2970m",
      "memory" : "4558Mi"
    }
  }
}

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