文档首页/魔坊（ModelArts）模型训推平台/API参考/节点池管理/查询节点池的节点列表 - ListNodePoolNodes
更新时间：2026-04-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询节点池的节点列表 - ListNodePoolNodes

功能介绍

查询节点池的节点列表接口用于获取指定节点池中所有节点的详细信息。该接口适用于以下场景：当需要查看节点池的节点状态、资源使用情况或管理节点资源时，用户可通过此接口获取节点池中节点的详细信息。使用该接口的前提条件是节点池已存在且用户具有访问该节点池的权限。调用接口成功后，系统将返回节点池中所有节点的列表，包括节点ID、名称、状态、IP地址、资源使用情况等详细信息。若节点池不存在、用户无权限访问或节点池当前不可用，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

pool_name

是

String

参数解释：资源池名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

nodepool_name

是

String

参数解释：节点池名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

continue

否

String

参数解释：分页查询时上一页位置。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

limit

否

String

参数解释：分页单次查询返回数。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

参数解释：资源的API版本。

取值范围：可选值如下：

  • v2：当前资源版本为v2。

kind

String

参数解释：资源的类型。

取值范围：可选值如下：

  • NodeList：节点列表。

metadata

NodeListMetadata object

参数解释：节点列表的元信息。

items

Array of Node objects

参数解释：节点资源列表。

表4 NodeListMetadata

参数

参数类型

描述

continue

String

参数解释：分页查询的偏移标志。

取值范围：取值来自用户上一次分页查询响应结果中metadata.continue中的值，值为空默认无偏移。

remainingItemCount

Long

参数解释：分页查询中剩余资源的数量。

默认取值：不涉及。

表5 Node

参数

参数类型

描述

apiVersion

String

参数解释：资源的API版本。

取值范围：可选值如下：

  • v2：当前资源版本为v2。

kind

String

参数解释：资源的类型。

取值范围：可选值如下：

  • Node：节点。

metadata

NodeMetadata object

参数解释：节点资源的元信息。

spec

NodeSpec object

参数解释：节点资源的规格信息。

status

NodeStatus object

参数解释：节点资源的状态信息。

表6 NodeMetadata

参数

参数类型

描述

name

String

参数解释：节点名称。

取值范围：不涉及。

creationTimestamp

String

参数解释：创建时间。

取值范围：不涉及。

labels

NodeLabels object

参数解释：节点上的标签信息。

annotations

NodeVOAnnotations object

参数解释：节点annotations信息。

表7 NodeLabels

参数

参数类型

描述

os.modelarts.node/cluster

String

参数解释：节点所在的集群名称。

取值范围：不涉及。

os.modelarts.node/elastic.quota

String

参数解释：节点绑定的逻辑池。

取值范围：不涉及。

os.modelarts.node/nodepool

String

参数解释：节点所在的节点池id。

取值范围：不涉及。

os.modelarts.node/batch.uid

String

参数解释：批量创建批次标识。

取值范围：不涉及。

os.modelarts.node/batch.name

String

参数解释：批量创建批次名称。

取值范围：不涉及。

os.modelarts.node/batch.type

String

参数解释：批量创建批次类型。

取值范围：可选值如下：

  • hyperinstance：超节点。

os.modelarts.node/batch.count

String

参数解释：批量创建的节点个数。

取值范围：不涉及。

os.modelarts/resource.id

String

参数解释：节点的资源id。

取值范围：不涉及。

os.modelarts/tenant.domain.id

String

参数解释：节点的租户id，记录节点创建在哪个租户账号下。

取值范围：不涉及。

os.modelarts/tenant.project.id

String

参数解释：节点的项目id，记录节点创建在租户账号下哪个项目中。

取值范围：不涉及。

os.modelarts/billing.status

String

参数解释：节点计费状态。

取值范围：可选值如下：

  • 0：正常状态。

  • 1：冻结状态。

  • 2：删除状态或者终止状态。

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

String

参数解释：标识该节点是否被整柜作业独占。当被某个整柜作业独占时，该标签存在，标签的值为独占的训练作业ID。

取值范围：不涉及。

cce.kubectl.kubernetes.io/cabinet

String

参数解释：节点所在tor交换机ip。多个tor交换机ip之间以中划线-分隔。

取值范围：不涉及。

os.modelarts.node/underlying.instance.id

String

参数解释：节点底层资源的实例ID，如超节点的ECS实例ID。

取值范围：不涉及。

os.modelarts.node/ha.redundant.enabled

String

参数解释：节点是否启用高可用冗余。

取值范围：

  • true：开启

  • false：未开启

os.modelarts.node/nodepoolname

String

参数解释：节点所在的节点池名称,最小长度为2，最大长度为50的小写字母、中划线-、数字组成，由小写字母开头，不能 以-，-default结尾。

取值范围：不涉及。

表8 NodeVOAnnotations

参数

参数类型

描述

os.modelarts/npu-topology-placement

String

参数解释：NPU卡的资源使用拓扑信息，长度为16的二进制编码，右起第一位编码代表卡1。其中，1表示占用，0表示空闲。例如，16卡的机型中卡1和卡15被占用，值为0100000000000001；8卡的机型中卡1和卡7被占用，返回值为0000000001000001。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

表9 NodeSpec

参数

参数类型

描述

flavor

String

参数解释：节点资源规格ID。

取值范围：不涉及。

os

Os object

参数解释：操作系统镜像信息。

hostNetwork

NodeNetwork object

参数解释：节点网络信息。

rootVolume

VolumeVO object

参数解释：系统盘信息。

dataVolumes

Array of VolumeVO objects

参数解释：数据盘信息。

extendParams

ResourceExtendParams object

参数解释：自定义配置。

表10 Os

参数

参数类型

描述

name

String

参数解释：操作系统名称和版本，如EulorOS 2.5。指定私有镜像时可不指定。

取值范围：不涉及。

imageId

String

参数解释：操作系统镜像id。

取值范围：不涉及。

imageType

String

参数解释：操作系统镜像类型。设置私有镜像时必须指定。默认为预置镜像，无需指定该字段。

取值范围：可选值如下：

  • private：私有镜像

  • ""：不指定类型即预置镜像。

autoMatch

String

参数解释：操作系统镜像自动匹配配置。当配置该参数时将会自动选择最优镜像，同时该参数会自动清空。

取值范围：操作系统名称和版本，如EulorOS 2.5。

表11 NodeNetwork

参数

参数类型

描述

vpc

String

参数解释：vpc id。

取值范围：不涉及。

subnet

String

参数解释：子网id。

取值范围：不涉及。

securityGroups

Array of strings

参数解释：安全组id集合。

表12 VolumeVO

参数

参数类型

描述

volumeType

String

参数解释：磁盘类型，具体内容可参考磁盘类型及性能介绍。

取值范围：

  • SSD：超高IO硬盘

  • GPSSD：通用型SSD

size

String

参数解释：磁盘大小，单位为Gi。

取值范围：不涉及。

count

Integer

参数解释：磁盘个数。不指定默认值为1。

取值范围：不涉及。

表13 ResourceExtendParams

参数

参数类型

描述

dockerBaseSize

String

参数解释：节点的容器镜像空间大小。

取值范围：可选值如下：

  • 指定大小：dockerBaseSize的大小范围默认为50-500，但实际上限受到节点的容器数据盘大小约束。

  • 不限制：dockerBaseSize="0"，表示不限制容器镜像空间大小。

postInstall

String

参数解释：安装后执行脚本，输入的值需要经过Base64编码。

取值范围：不涉及。

runtime

String

参数解释：容器运行时。

取值范围：可选值如下：

  • docker：容器运行时，是目前最常用的容器化引擎，基于容器镜像创建和管理容器实例。

  • containerd：工业级的容器运行时，专注于容器的生命周期管理，是 Docker 底层核心组件之一，也可独立部署使用。

labelPolicyOnExistingNodes

String

参数解释：存量节点k8s标签更新策略，值为空时默认更新存量节点。

取值范围：可选值如下：

  • refresh：更新。

  • ignore：不更新。

taintPolicyOnExistingNodes

String

参数解释：存量节点k8s污点更新策略，值为空时默认更新存量节点。

取值范围：可选值如下：

  • refresh：更新。

  • ignore：不更新。

tagPolicyOnExistingNodes

String

参数解释：存量节点资源标签更新策略，值为空时默认更新存量节点。

取值范围：可选值如下：

  • refresh：更新。

  • ignore：不更新。

XParameterPlaneSubnet

String

参数解释：跨物理集群之间进行参数面数据传输使用的子网id。不可与节点子网和容器子网重复。

取值范围：不涉及。

nodePoolName

String

参数解释：用户指定的节点池名称。最小长度为2，最大长度为50的小写字母、中划线-、数字组成，由小写字母开头，不能以-，-default结尾。

取值范围：不涉及

表14 NodeStatus

参数

参数类型

描述

phase

String

参数解释：节点当前状态。

取值范围：可选值如下：

  • Available：节点可用。

  • Creating：节点创建中。

  • Deleting：节点删除中。

  • Abnormal：节点异常。

  • Checking: 节点自检中。

az

String

参数解释：节点所在的az。

取值范围：不涉及。

privateIp

String

参数解释：节点的IP地址。

取值范围：不涉及。

resources

NodeResource object

参数解释：节点资源量信息。

availableResources

NodeResource object

参数解释：节点可用资源量信息。

表15 NodeResource

参数

参数类型

描述

cpu

String

参数解释：节点的CPU核心数量。

取值范围：不涉及。

memory

String

参数解释：节点的内存大小。以Gi为单位。

取值范围：不涉及。

nvidia.com/gpu

String

参数解释：节点的GPU卡数。

取值范围：不涉及。

huawei.com/ascend-snt3

String

参数解释：节点的snt3型NPU卡数量。

取值范围：不涉及。

huawei.com/ascend-snt9

String

参数解释：节点的snt9型NPU卡数量。

取值范围：不涉及。

状态码：400

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

请求示例

查询节点池的节点列表。

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

{
  "kind" : "NodeList",
  "apiVersion" : "v2",
  "metadata" : { },
  "items" : [ {
    "kind" : "Node",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "node-dly-4",
      "creationTimestamp" : "2024-01-29T09:28:26Z",
      "labels" : {
        "os.modelarts.node/cluster" : "dly-lite",
        "os.modelarts.node/nodepool" : "nodepool-1"
      }
    },
    "spec" : {
      "flavor" : "modelarts.vm.2u4g.dcc",
      "hostNetwork" : {
        "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
        "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
        "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
      }
    },
    "status" : {
      "phase" : "Available",
      "az" : "cn-north-7c",
      "privateIp" : "192.168.1.132",
      "resources" : {
        "cpu" : "1930m",
        "memory" : "1912Mi"
      }
    }
  } ]
}

响应示例

状态码：200

OK。

{
  "kind" : "NodeList",
  "apiVersion" : "v2",
  "metadata" : { },
  "items" : [ {
    "kind" : "Node",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "node-dly-4",
      "creationTimestamp" : "2024-01-29T09:28:26Z"
    },
    "spec" : {
      "flavor" : "modelarts.vm.2u4g.dcc"
    },
    "status" : {
      "phase" : "Available",
      "az" : "cn-north-7c",
      "privateIp" : "192.168.1.132",
      "resources" : {
        "cpu" : "1930m",
        "memory" : "1912Mi"
      }
    }
  } ]
}

状态码：400

Bad request

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request. invalid nodepool name"
}

状态码

状态码

描述

200

OK。

400

Bad request

错误码

请参见错误码。

父主题：节点池管理

相关文档