查询资源池节点列表
功能介绍
查询资源池节点列表接口用于获取指定资源池中的节点信息列表。该接口适用于以下场景:当需要了解资源池中节点的分布、状态或资源使用情况时,用户可通过此接口查询资源池中的节点列表,以便进行资源监控、分配或管理。使用该接口的前提条件是资源池已创建且处于可用状态,且用户具有访问资源池的权限。查询操作完成后,用户将获得资源池中节点的详细信息,包括节点ID、状态、资源使用情况等,便于后续的资源管理和优化。若资源池不存在、用户无权限访问或请求参数无效,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/pools/{pool_name}/nodes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
|
pool_name |
是 |
String |
参数解释:资源池的ID,取值自资源池详情的metadata.name字段。 约束限制:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为36-63个字符。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
continue |
否 |
String |
参数解释:分页查询的偏移标志。 约束限制:可选。 取值范围:取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。 默认取值:不涉及。 |
|
limit |
否 |
Integer |
参数解释:分页单次查询返回的资源数量。 约束限制:不涉及。 取值范围:0 - 500。 默认取值:500。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释:资源的API版本。 取值范围:可选值如下:
|
|
kind |
String |
参数解释:资源的类型。 取值范围:可选值如下:
|
|
metadata |
NodeListMetadata object |
参数解释:节点列表的元信息。 |
|
items |
Array of Node objects |
参数解释:节点资源列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
continue |
String |
参数解释:分页查询的偏移标志。 取值范围:取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。 |
|
remainingItemCount |
Long |
参数解释:分页查询中剩余资源的数量。 默认取值:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释:资源的API版本。 取值范围:可选值如下:
|
|
kind |
String |
参数解释:资源的类型。 取值范围:可选值如下:
|
|
metadata |
Object |
参数解释:节点资源的元信息。 |
|
spec |
NodeSpec object |
参数解释:节点资源的规格信息。 |
|
status |
NodeStatus object |
参数解释:节点资源的状态信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor |
String |
参数解释:节点资源规格ID。 取值范围:不涉及。 |
|
extendParams |
Object |
参数解释:节点自定义配置信息。 |
|
os |
Os object |
参数解释:节点操作系统信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释:操作系统名称。 取值范围:不涉及。 |
|
imageId |
String |
参数解释:操作系统镜像ID。 取值范围:不涉及。 |
|
imageType |
String |
参数解释:操作系统镜像类型。 取值范围:可选值如下:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
phase |
String |
参数解释:节点当前状态。 取值范围:可选值如下:
|
|
az |
String |
参数解释:节点所在的az。 取值范围:不涉及。 |
|
privateIp |
String |
参数解释:节点的IP地址。 取值范围:不涉及。 |
|
resources |
NodeResource object |
参数解释:节点资源量信息。 |
|
availableResources |
NodeResource object |
参数解释:节点可用资源量信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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。 |
错误码
请参见错误码。