ListNodes - 获取节点列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取资源节点列表。

接口说明

您可以通过 ListNodes 获取指定过滤条件的资源节点

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/nodes

请求参数

名称	类型	必填	描述	示例值
ResourceGroupIds	string	否	指定资源组 ID 列表，按逗号分隔，和 QuotaId 参数二选一必填约束：需校验传入的 ResourceGroupId 的 UserId 和请求的 UserId 一致传入的 ResourceGroup 列表类型需一致传入的 ResourceGroup 列表现阶段记录的 VPC 需一致	rg69rj0leslwdnbe
QuotaId	string	否	节点所属资源配额 ID。	quotamtl37ge7gkvdz
NodeTypes	string	否	资源节点规格列表，按逗号分隔，不设置会返回所有资源节点规格的机器列表。	ecs.c6.xlarge
AcceleratorType	string	否	加速器类型，枚举： CPU GPU 默认为空，代表所有类型。	CPU
GPUType	string	否	按卡类型，支持模糊匹配。	T4
NodeStatuses	string	否	节点所处状态。按逗号分隔，不设置会返回所有状态的节点列表。	Ready
OrderStatuses	string	否	节点所在订单状态。	Ready
PageNumber	integer	否	分页页码，从 1 开始。	2
PageSize	integer	否	分页查询每页数据集数量。	10
SortBy	string	否	排序依据。	GmtCreateTime
Order	string	否	排列顺序，取值： desc：降序。 asc：升序。	desc
Verbose	boolean	否	是否返回资源使用信息。只在 QuotaId 设置时生效。	false
NodeNames	string	否	只显示指定节点，按逗号分隔。	lingjxxxx
FilterByQuotaId	string	否	与 ResourceGroupIds 同时使用，展示资源组里面 Quota 绑定某些 Quota 的 node。	quotamtl37ge7gkvdz
FilterByResourceGroupIds	string	否	与 QuotaId 同时使用，展示 Quota 中属于某些资源组的 node。	rg69rj0leslwdnbe

返回参数

名称	类型	描述	示例值
	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": "\"\"",
      "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"
        }
      ]
    }
  ],
  "TotalCount": 23
}

错误码

访问错误中心查看更多错误码。