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

查询资源池节点列表

功能介绍

查询资源池中的节点列表。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

pool_name

是

String

参数解释：资源池的ID，取值自资源池详情的metadata.name字段。

约束限制：不涉及。

取值范围：只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长度为36-63个字符。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

continue

否

String

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

约束限制：可选。

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

默认取值：不涉及。

limit

否

Integer

参数解释：分页单次查询返回的资源数量。

约束限制：不涉及。

取值范围：0 - 500。

默认取值：500。

请求参数

无

响应参数

状态码：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

metadata object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

spec

NodeSpec object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

status

NodeStatus object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表6 metadata

参数

参数类型

描述

name

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

creationTimestamp

String

参数解释：节点的创建时间。例如"2025-11-01T03:49:41Z"。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

annotations

NodeVOAnnotations object

参数解释：节点的注释信息。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表7 NodeVOAnnotations

参数

参数类型

描述

os.modelarts/npu-topology-placement

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表8 NodeSpec

参数

参数类型

描述

flavor

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

extendParams

extendParams object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

os

Os object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表9 extendParams

参数

参数类型

描述

dockerBaseSize

String

参数解释：节点容器引擎空间大小。值为0时表示不限制大小。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表10 Os

参数

参数类型

描述

name

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

imageId

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

imageType

String

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

约束限制：不涉及。

取值范围：可选值如下：

  • private：私有镜像。

默认取值：不涉及。
表11 NodeStatus

参数

参数类型

描述

phase

String

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

约束限制：不涉及。

取值范围：可选值如下：

  • Available：节点可用。

  • Creating：节点创建中。

  • Deleting：节点删除中。

  • Abnormal：节点异常。

  • Checking: 节点自检中。

默认取值：不涉及。

az

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

privateIp

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

resources

NodeResource object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

availableResources

NodeResource object

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表12 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卡数量。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

状态码：404

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

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

取值范围：不涉及。

请求示例

查询资源池的节点列表。

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

{ }

响应示例

状态码：200

OK。

{
  "kind" : "NodeList",
  "apiVersion" : "v2",
  "metadata" : { },
  "items" : [ {
    "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" : "cn-north-7c",
      "privateIp" : "192.168.0.1",
      "resources" : {
        "cpu" : "3920m",
        "memory" : "6270Mi"
      },
      "availableResources" : {
        "cpu" : "2970m",
        "memory" : "4558Mi"
      }
    }
  }, {
    "kind" : "Node",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "os-node-created-4s522",
      "creationTimestamp" : "2022-09-16T03:20:53Z"
    },
    "spec" : {
      "flavor" : "modelarts.vm.cpu.4ud"
    },
    "status" : {
      "phase" : "Available",
      "az" : "cn-north-7c",
      "privateIp" : "192.168.0.2",
      "resources" : {
        "cpu" : "3920m",
        "memory" : "6270Mi"
      },
      "availableResources" : {
        "cpu" : "2970m",
        "memory" : "4558Mi"
      }
    }
  }, {
    "kind" : "Node",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "os-node-created-v7hfj",
      "creationTimestamp" : "2022-09-16T09:16:37Z"
    },
    "spec" : {
      "flavor" : "modelarts.vm.cpu.4ud"
    },
    "status" : {
      "phase" : "Available",
      "az" : "cn-north-7c",
      "privateIp" : "192.168.0.3",
      "resources" : {
        "cpu" : "3920m",
        "memory" : "6270Mi"
      },
      "availableResources" : {
        "cpu" : "3720m",
        "memory" : "5670Mi"
      }
    }
  } ]
}

状态码：404

Not Found。

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

状态码

状态码

描述

200

OK。

404

Not Found。

错误码

请参见错误码。

父主题： 资源管理

相关文档