文档首页/ AI开发平台ModelArts/ API参考/ 节点池管理/ 查询节点池的节点列表
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询节点池的节点列表

功能介绍

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

调试

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

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

Object

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

spec

NodeSpec object

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

status

NodeStatus object

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

参数

参数类型

描述

flavor

String

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

取值范围：不涉及。

extendParams

Object

参数解释：节点自定义配置信息。

os

Os object

参数解释：节点操作系统信息。
表7 Os

参数

参数类型

描述

name

String

参数解释：操作系统名称。

取值范围：不涉及。

imageId

String

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

取值范围：不涉及。

imageType

String

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

取值范围：可选值如下：

  • private：私有镜像。
表8 NodeStatus

参数

参数类型

描述

phase

String

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

取值范围：可选值如下：

  • Available：节点可用。

  • Creating：节点创建中。

  • Deleting：节点删除中。

  • Abnormal：节点异常。

  • Checking: 节点自检中。

az

String

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

取值范围：不涉及。

privateIp

String

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

取值范围：不涉及。

resources

NodeResource object

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

availableResources

NodeResource object

参数解释：节点可用资源量信息。
表9 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

表10 响应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

错误码

请参见错误码。

父主题： 节点池管理