获取资源节点列表。
接口说明
您可以通过 ListNodes 获取指定过滤条件的资源节点
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/nodes HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceGroupIds |
string |
否 |
指定资源组 ID 列表，按逗号分隔，和 QuotaId 参数二选一必填 约束：
|
rg69rj0leslwdnbe |
| QuotaId |
string |
否 |
节点所属资源配额 ID。 |
quotamtl37ge7gkvdz |
| NodeTypes |
string |
否 |
资源节点规格列表，按逗号分隔，不设置会返回所有资源节点规格的机器列表。 |
ecs.c6.xlarge |
| AcceleratorType |
string |
否 |
加速器类型，枚举：
默认为空，代表所有类型。 |
CPU |
| GPUType |
string |
否 |
按卡类型，支持模糊匹配。 |
T4 |
| NodeStatuses |
string |
否 |
节点所处状态。按逗号分隔，不设置会返回所有状态的节点列表。 |
Ready |
| OrderStatuses |
string |
否 |
节点所在订单状态。 |
Ready |
| PageNumber |
integer |
否 |
分页页码，从 1 开始。 |
2 |
| PageSize |
integer |
否 |
分页查询每页数据集数量。 |
10 |
| SortBy |
string |
否 |
排序依据。 |
GmtCreateTime |
| Order |
string |
否 |
排列顺序，取值：
|
desc |
| Verbose |
boolean |
否 |
是否返回资源使用信息。只在 QuotaId 设置时生效。 |
false |
| NodeNames |
string |
否 |
只显示指定节点，按逗号分隔。 |
lingjxxxx |
| HyperNode |
string |
否 |
||
| CliqueID |
string |
否 |
||
| FilterByQuotaId |
string |
否 |
与 ResourceGroupIds 同时使用，展示资源组里面 Quota 绑定某些 Quota 的 node。 |
quotamtl37ge7gkvdz |
| FilterByResourceGroupIds |
string |
否 |
与 QuotaId 同时使用，展示 Quota 中属于某些资源组的 node。 |
rg69rj0leslwdnbe |
| MachineGroupIds |
string |
否 |
||
| ReasonCodes |
string |
否 |
||
| HyperZone |
string |
否 |
||
| AvailabilityZone |
string |
否 |
||
| PaymentType |
string |
否 |
||
| OrderInstanceIds |
string |
否 |
订单 Id 信息 |
260590501560397 |
| WorkspaceId |
string |
否 |
||
| HealthRate |
object |
否 |
||
| operation |
string |
否 |
||
| value |
integer |
否 |
||
| HealthCount |
object |
否 |
||
| operation |
string |
否 |
||
| value |
integer |
否 |
||
| LayoutMode |
string |
否 |
||
| ResourceGroupName |
string |
否 |
||
| DiskPL |
string |
否 |
||
| WorkloadNum |
integer |
否 |
||
| PodNum |
integer |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 Id |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Nodes |
array |
节点列表。 |
|
| Node |
节点信息。 |
||
| TotalCount |
integer |
符合过滤条件的节点数量。 |
23 |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Nodes": [
{
"CreatorId": "281044699048527748",
"NodeName": "lingjxxxx",
"NodeType": "ecs.c8i.xlarge",
"AcceleratorType": "CPU",
"CPU": "4",
"Memory": "8",
"GPU": "0",
"GPUType": "\"\"",
"GPUMemory": "",
"NodeStatus": "Ready",
"ReasonCode": "\"\"",
"ReasonMessage": "\"\"",
"OrderStatus": "Ready",
"ResourceGroupId": "rgf0zhfqn1d4ity2",
"ResourceGroupName": "test",
"MachineGroupId": "mg1234456",
"GmtCreateTime": "2024-07-10T11:49:47Z",
"GmtModifiedTime": "2024-07-10T11:49:47Z",
"GmtExpiredTime": "2025-06-22T00:00:00Z\n",
"IsBound": false,
"BoundQuotas": [
{
"QuotaId": "quota12345",
"QuotaName": "dlc-quota"
}
],
"RequestCPU": "4",
"RequestMemory": "8",
"RequestGPU": "0",
"LimitCPU": "4",
"LimitMemory": "8",
"LimitGPU": "0",
"PodNum": 2,
"WorkloadNum": 2,
"Users": [
{
"UserId": "161222222222",
"UserName": "test"
}
],
"HyperZone": "",
"AvailabilityZone": "",
"AllocatableCPU": "",
"AllocatableMemory": "",
"SystemReservedCPU": "",
"SystemReservedMemory": "",
"AncestorQuotaWorkloadNum": 0,
"SelfQuotaWorkloadNum": 0,
"DescendantQuotaWorkloadNum": 0,
"DiskPL": "",
"DiskCapacity": 0,
"SubNodes": [
""
]
}
],
"TotalCount": 23
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。