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

查询节点池列表

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

pool_name

是

String

参数解释：资源池名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

apiVersion

String

参数解释： API版本。

取值范围： 可选值如下：

  • v2

kind

String

参数解释： 资源类型。

取值范围： 可选值如下：

  • NodePoolList：节点列表

items

Array of NodePool objects

参数解释：节点池列表。
表3 NodePool

参数

参数类型

描述

apiVersion

String

参数解释： API版本。

取值范围： 可选值如下：

  • v2

kind

String

参数解释：节点池类型。

取值范围： 可选值如下：

  • NodePool：节点池

metadata

NodePoolMetadata object

参数解释： 节点池的metadata信息。

spec

NodePoolSpec object

参数解释：节点池的期望信息。

status

NodePoolStatus object

参数解释： 节点池的状态信息。
表4 NodePoolMetadata

参数

参数类型

描述

name

String

参数解释： 节点池名称。用户可进行指定，若未指定将会使用默认名称。

取值范围： 不涉及。
表5 NodePoolSpec

参数

参数类型

描述

resources

PoolResource object

参数解释： 节点池中的资源信息列表，包括资源规格和相应规格的资源数量，自定义配置等。

取值范围： 不涉及。
表6 PoolResource

参数

参数类型

描述

flavor

String

参数解释： 资源规格名称，比如：modelarts.vm.gpu.t4u8。

取值范围： 不涉及。

count

Integer

参数解释： 规格保障使用量。

取值范围： 不涉及。

maxCount

Integer

参数解释： 资源规格的弹性使用量，物理池该值和count相同，逻辑池该值大于等于count。

取值范围： 不涉及。

azs

Array of PoolNodeAz objects

参数解释： 节点池az分布。

nodePool

String

参数解释： 节点池名称。比如：nodePool-1。

取值范围： 不涉及。

taints

Array of Taints objects

参数解释： 支持给创建出来的节点加taints来设置反亲和性，非特权池不能指定。

labels

Map<String,String>

参数解释： k8s标签，格式为key/value键值对。

取值范围： 不涉及。

tags

Array of UserTags objects

参数解释： 资源标签，非特权池不能指定。

取值范围： 不涉及。

network

NodeNetwork object

参数解释：网络配置，非特权池不能指定。

extendParams

Map<String,String>

参数解释：自定义配置参数。

  • "dockerBaseSize": 指定资源池节点的容器引擎空间大小。值为0时表示不限制大小。

creatingStep

CreatingStep object

参数解释：批量创建信息。

os

Os object

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

参数

参数类型

描述

key

String

参数解释：键。

取值范围：不涉及。

value

String

参数解释：值。

取值范围：不涉及。

effect

String

参数解释：作用效果。

取值范围：不涉及。
表8 UserTags

参数

参数类型

描述

key

String

参数解释：键。不得以"CCE-"或"__type_baremetal"开头"。

取值范围：不涉及。

value

String

参数解释：值。

取值范围：不涉及。
表9 NodeNetwork

参数

参数类型

描述

vpc

String

参数解释：vpc id。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

subnet

String

参数解释：子网id。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

securityGroups

Array of strings

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

约束限制：不涉及。
表10 CreatingStep

参数

参数类型

描述

step

Integer

参数解释：超节点的步长。仅支持资源规格详情中包含的步长。

取值范围：不涉及。

type

String

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

取值范围：可选值如下：

  • hyperinstance：超节点。
表11 Os

参数

参数类型

描述

name

String

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

取值范围：不涉及。

imageId

String

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

取值范围：不涉及。

imageType

String

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

取值范围：可选值如下：

  • private：私有镜像。
表12 NodePoolStatus

参数

参数类型

描述

resources

resources object

参数解释：节点池中不同状态的资源量。
表13 resources

参数

参数类型

描述

creating

PoolResourceFlavorCount object

参数解释：状态为创建中状态的资源量。

available

PoolResourceFlavorCount object

参数解释：状态为可用状态的资源量。

abnormal

PoolResourceFlavorCount object

参数解释：状态为非正常状态的资源量。

deleting

PoolResourceFlavorCount object

参数解释：状态为删除中状态的资源量。
表14 PoolResourceFlavorCount

参数

参数类型

描述

flavor

String

参数解释：资源规格ID。

取值范围：不涉及。

count

Integer

参数解释：资源池中资源规格实例数量。

取值范围：不涉及。

maxCount

Integer

参数解释：资源池中资源规格实例弹性数量。物理池中该值和count相同。

取值范围：不涉及。

azs

Array of PoolNodeAz objects

参数解释：资源池中期望创建的资源规格实例的az分布。

nodePool

String

参数解释：节点池ID。

取值范围：不涉及。
表15 PoolNodeAz

参数

参数类型

描述

az

String

参数解释：可用区名称。

取值范围：不涉及。

count

Integer

参数解释：可用区资源实例的数量。

取值范围：不涉及。

请求示例

查询节点池列表。

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

{ }

响应示例

状态码：200

OK。

{
  "kind" : "NodePoolList",
  "apiVersion" : "v2",
  "items" : [ {
    "kind" : "NodePool",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "modelarts.vm.2u4g.dcc-Default"
    },
    "spec" : {
      "resources" : {
        "nodePool" : "modelarts.vm.2u4g.dcc-Default",
        "flavor" : "modelarts.vm.2u4g.dcc",
        "count" : 1,
        "maxCount" : 1,
        "network" : {
          "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
          "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
          "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
        }
      }
    },
    "status" : {
      "resources" : {
        "available" : {
          "nodePool" : "modelarts.vm.2u4g.dcc-Default",
          "flavor" : "modelarts.vm.2u4g.dcc",
          "count" : 1,
          "maxCount" : 1,
          "azs" : [ {
            "az" : "cn-north-7c",
            "count" : 1
          } ]
        }
      }
    }
  }, {
    "kind" : "NodePool",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "nodepool-1"
    },
    "spec" : {
      "resources" : {
        "nodePool" : "nodepool-1",
        "flavor" : "modelarts.vm.2u4g.dcc",
        "count" : 1,
        "maxCount" : 1,
        "network" : {
          "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
          "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
          "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
        }
      }
    },
    "status" : {
      "resources" : {
        "available" : {
          "nodePool" : "nodepool-1",
          "flavor" : "modelarts.vm.2u4g.dcc",
          "count" : 1,
          "maxCount" : 1,
          "azs" : [ {
            "az" : "cn-north-7c",
            "count" : 1
          } ]
        }
      }
    }
  } ]
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码。

父主题： 节点池管理

相关文档