文档首页/ AI开发平台ModelArts/ API参考/ 资源管理/ 查询资源池节点列表 - ListPoolNodes

更新时间：2026-01-08 GMT+08:00

CLI示例

查看PDF

查询资源池节点列表 - ListPoolNodes

功能介绍

查询资源池节点列表接口用于获取指定资源池中的节点信息列表。该接口适用于以下场景：当需要了解资源池中节点的分布、状态或资源使用情况时，用户可通过此接口查询资源池中的节点列表，以便进行资源监控、分配或管理。使用该接口的前提条件是资源池已创建且处于可用状态，且用户具有访问资源池的权限。查询操作完成后，用户将获得资源池中节点的详细信息，包括节点ID、状态、资源使用情况等，便于后续的资源管理和优化。若资源池不存在、用户无权限访问或请求参数无效，接口将返回相应的错误信息。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:pool:get	Read	pool *	g:ResourceTag/<tag-key>	-	-
modelarts:pool:get	Read	-	g:EnterpriseProjectId	-	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID，获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。
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	Object	参数解释：节点资源的元信息。
spec	NodeSpec object	参数解释：节点资源的规格信息。
status	NodeStatus object	参数解释：节点资源的状态信息。

表6 NodeSpec
参数	参数类型	描述
flavor	String	参数解释：节点规格。取值范围：不涉及。
os	Os object	参数解释：操作系统镜像信息。
hostNetwork	NodeNetwork object	参数解释：节点网络信息。
rootVolume	VolumeVO object	参数解释：系统盘信息。
dataVolumes	Array of VolumeVO objects	参数解释：数据盘信息。
extendParams	ResourceExtendParams object	参数解释：自定义配置。

表7 Os
参数	参数类型	描述
name	String	参数解释：操作系统名称和版本，如EulorOS 2.5。指定私有镜像时可不指定。取值范围：不涉及。
imageId	String	参数解释：操作系统镜像id。取值范围：不涉及。
imageType	String	参数解释：操作系统镜像类型。设置私有镜像时必须指定。默认为预置镜像，无需指定该字段。取值范围：可选值如下： private：私有镜像 ""：不指定类型即预置镜像。
autoMatch	String	参数解释：操作系统镜像自动匹配配置。当配置该参数时将会自动选择最优镜像，同时该参数会自动清空。取值范围：操作系统名称和版本，如EulorOS 2.5。

表8 NodeNetwork
参数	参数类型	描述
vpc	String	参数解释：vpc id。取值范围：不涉及。
subnet	String	参数解释：子网id。取值范围：不涉及。
securityGroups	Array of strings	参数解释：安全组id集合。

表9 VolumeVO
参数	参数类型	描述
volumeType	String	参数解释：磁盘类型，具体内容可参考磁盘类型及性能介绍。取值范围： SSD：超高IO硬盘 GPSSD：通用型SSD
size	String	参数解释：磁盘大小，单位为Gi。取值范围：不涉及。
count	Integer	参数解释：磁盘个数。不指定默认值为1。取值范围：不涉及。

**表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** 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。

错误码

请参见错误码。

父主题： 资源管理

上一篇：查询插件模板列表 - ListPluginTemplates

下一篇：批量删除节点 - BatchDeletePoolNodes

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问