文档首页/ 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}

表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 Taint objects

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

labels

Map<String,String>

k8s标签，格式为key/value键值对。

tags

Array of UserTag objects

资源标签，非特权池不能指定。

network

NodeNetwork object

网络配置，非特权池不能指定。

extendParams

Map<String,String>

自定义配置，比如设置节点dockerSize："extendParams": {"dockerBaseSize": "100" }。

creatingStep

CreatingStep object

批量创建信息。
表7 PoolNodeAz

参数

参数类型

描述

az

String

可用区名称。

count

Integer

指定可用区扩容时，指定可用区的节点数。
表8 Taint

参数

参数类型

描述

key

String

键。

value

String

值。

effect

String

作用效果。
表9 UserTag

参数

参数类型

描述

key

String

键。不得以"CCE-"或"__type_baremetal"开头

value

String

值。
表10 NodeNetwork

参数

参数类型

描述

vpc

String

vpc id。

subnet

String

子网id。

securityGroups

Array of strings

安全组id集合。
表11 CreatingStep

参数

参数类型

描述

step

Integer

创建步长。

type

String

批量创建类型。可选值如下：

  • rack：表示整柜。
表12 NodePoolStatus

参数

参数类型

描述

resources

resources object

节点池中不同状态的资源量。
表13 resources

参数

参数类型

描述

creating

PoolResourceFlavorCount object

状态为创建中状态的资源量。

available

PoolResourceFlavorCount object

状态为可用状态的资源量。

abnormal

PoolResourceFlavorCount object

状态为非正常状态的资源量。

deleting

PoolResourceFlavorCount object

状态为删除中状态的资源量。
表14 PoolResourceFlavorCount

参数

参数类型

描述

flavor

String

资源规格名称，比如：modelarts.vm.gpu.tnt004。

count

Integer

规格保障使用量。

maxCount

Integer

资源规格的弹性使用量，物理池该值和count相同。

azs

Array of azs objects

资源所在的AZ的数量。

nodePool

String

节点池名称。比如：nodePool-1。
表15 azs

参数

参数类型

描述

az

String

AZ的名称。

count

Integer

AZ的资源数量。

状态码： 400

表16 响应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

错误码

请参见错误码。

父主题： 节点池管理

相关文档