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

查询指定节点池详情 - ShowNodePool

功能介绍

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

调试

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

授权信息

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

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

URI

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

表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

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相同。

取值范围：不涉及。

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

ResourceExtendParams object

参数解释：自定义配置。

creatingStep

CreatingStep object

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

rootVolume

RootVolume object

参数解释：自定义系统盘（云硬盘）信息。

dataVolumes

Array of DataVolumeItem objects

参数解释：自定义数据盘（云硬盘）列表信息。

volumeGroupConfigs

Array of VolumeGroupConfig objects

参数解释：磁盘高级配置。存在自定义数据盘时必须指定对应的高级配置。

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 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结尾。

取值范围：不涉及

表11 CreatingStep

参数

参数类型

描述

step

Integer

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

取值范围：不涉及。

type

String

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

取值范围：可选值如下：

  • hyperinstance：超节点。

表12 RootVolume

参数

参数类型

描述

volumeType

String

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

取值范围：可选值如下：

  • SSD：超高IO硬盘

  • GPSSD：通用型SSD

  • SAS：高IO硬盘

size

String

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

取值范围：不涉及。

表13 DataVolumeItem

参数

参数类型

描述

volumeType

String

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

取值范围：可选值如下：

  • SSD：超高IO硬盘

  • GPSSD：通用型SSD

  • SAS：高IO硬盘

size

String

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

取值范围：不涉及。

count

Integer

参数解释：磁盘个数。

取值范围：不涉及。

extendParams

VolumeExtendParams object

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

表14 VolumeExtendParams

参数

参数类型

描述

volumeGroup

String

参数解释：磁盘分组名称，用于各个存储空间的划分。

取值范围：可选项如下：

  • vgpaas：容器盘。

  • default：普通数据盘，以默认方式挂载。

  • vguser：普通数据盘，指定挂载路径，不同路径的分组名称不同，如vguser1，vguser2。

  • vg-everest-localvolume-persistent：普通数据盘，作为持久存储卷

  • vg-everest-localvolume-ephemeral：普通数据盘，作为临时存储卷

表15 VolumeGroupConfig

参数

参数类型

描述

volumeGroup

String

参数解释：磁盘分组名称。作为dataVolumes中volumeGroup的索引。

取值范围：不涉及。

dockerThinPool

Integer

参数解释：资源池节点容器盘占数据盘的百分比。仅磁盘分组名称为vgpaas时，即容器盘，才可指定此参数。

取值范围：不涉及。

lvmConfig

LvmConfig object

参数解释：LVM配置管理。

types

Array of strings

参数解释：存储类型。可选项如下：

  • volume：云硬盘。当指定dataVolumes时，该值为缺省值。

  • local：本地盘。使用本地盘必须指定该字段。

表16 LvmConfig

参数

参数类型

描述

lvType

String

参数解释：LVM写入模式。

取值范围：可选项如下：

  • linear：线性模式。

  • striped：条带模式，使用多块磁盘组成条带模式，能够提升磁盘性能。

path

String

参数解释：磁盘挂载路径。仅在用户配置中生效。支持包含：数字、大小写字母、点、中划线、下划线的绝对路径。

取值范围：不涉及。

表17 Os

参数

参数类型

描述

name

String

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

取值范围：不涉及。

imageId

String

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

取值范围：不涉及。

imageType

String

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

取值范围：可选值如下：

  • private：私有镜像

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

autoMatch

String

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

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

表18 NodePoolStatus

参数

参数类型

描述

resources

resources object

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

表19 resources

参数

参数类型

描述

creating

PoolResourceFlavorCount object

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

available

PoolResourceFlavorCount object

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

abnormal

PoolResourceFlavorCount object

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

deleting

PoolResourceFlavorCount object

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

表20 PoolResourceFlavorCount

参数

参数类型

描述

flavor

String

参数解释：资源规格ID。

取值范围：不涉及。

count

Integer

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

取值范围：不涉及。

maxCount

Integer

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

取值范围：不涉及。

azs

Array of PoolNodeAz objects

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

nodePool

String

参数解释：节点池ID。

取值范围：不涉及。

表21 PoolNodeAz

参数

参数类型

描述

az

String

参数解释：可用区名称。

取值范围：不涉及。

count

Integer

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

取值范围：不涉及。

状态码：400

表22 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

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

取值范围：不涉及。

请求示例

查询指定节点池详情。

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

{ }

响应示例

状态码：200

OK。

{
  "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
        } ]
      }
    }
  }
}

状态码：400

Bad request

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

状态码

状态码

描述

200

OK。

400

Bad request

错误码

请参见错误码。

父主题：节点池管理

相关文档