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

查询节点池的节点列表

功能介绍

查询节点池的节点列表。

调试

您可以在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

kind

String

资源类型。可选值如下：

  • NodeList：节点列表

metadata

NodeListMetadata object

资源列表的metadata信息。

items

Array of Node objects

节点列表。
表4 NodeListMetadata

参数

参数类型

描述

continue

String

分页查询时，下一次查询位置。

remainingItemCount

Long

剩余资源个数。
表5 Node

参数

参数类型

描述

apiVersion

String

API版本。可选值如下：

  • v2

kind

String

资源类型。可选值如下：

  • Node：节点

metadata

metadata object

节点metadata信息。

spec

NodeSpec object

节点期望信息。

status

NodeStatus object

节点状态信息。
表6 metadata

参数

参数类型

描述

name

String

节点名称。

creationTimestamp

String

创建时间。
表7 NodeSpec

参数

参数类型

描述

flavor

String

节点规格。
表8 NodeStatus

参数

参数类型

描述

phase

String

节点当前状态。可选值如下：

  • Available：节点可用

  • Creating：节点创建中

  • Deleting：节点删除中

  • Abnormal：节点不正常

  • Checking: 节点自检中

az

String

节点所在的可用区。

privateIp

String

节点的IP地址。

resources

NodeResource object

节点资源量信息。

availableResources

NodeResource object

节点可用资源量信息。
表9 NodeResource

参数

参数类型

描述

cpu

String

CPU资源量。

memory

String

内存资源量。

nvidia.com/gpu

String

GPU节点的GPU资源量。

huawei.com/ascend-snt3

String

昇腾节点的NPU资源量。

huawei.com/ascend-snt9

String

昇腾节点的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

错误码

请参见错误码。

父主题： 节点池管理

相关文档