调用ListClusters查询集群列表_人工智能平台 PAI(PAI)-阿里云帮助中心

查询集群实例列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
eflo:ListClusters	get	Cluster acs:eflo:{#regionId}:{#accountId}:cluster/*	无	无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	a3f2224a5ec7224116c4f5246120abe4
MaxResults	long	否	分页查询时每页行数，默认值为 20。	20
ResourceGroupId	string	否	资源组 id	rg-aek2bg6wyoox6jq

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 id	2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
Clusters	array<object>	集群信息
	object
Components	any	组件信息	{}
ClusterId	string	集群 id	i137590131672134915401
ClusterName	string	集群 name	cnp_test_cluster
OperatingState	string	集群状态枚举值： running：运行中。 expanding：扩容中。 shrinking：缩容中。 initializing：初始化中。	initializing
TaskId	string	任务 id	i156365121663149566024
ClusterType	string	集群类型枚举值： AckEdgePro：基于ACK@Edge Pro的灵骏集群。 ExclusiveBareCluster：专属裸集群。 Lite：基础版灵骏集群。	AckEdgePro
NodeCount	long	节点数量	12
NodeGroupCount	long	节点组数量	2
CreateTime	string	创建时间	1672134938
UpdateTime	string	更新时间	1672134968
ClusterDescription	string	集群描述	测试集群
ResourceGroupId	string	资源组 id	rg-aek2ajbjoloa23q
VpcId	string	专有网络 id	vpc-0jlx4hol2bjboafzmffvd
HpnZone	string	集群编号	B1
ComputingIpVersion	string	计算网络的 IP 类型	IPv4
NextToken	string	本次调用返回的查询凭证值。	f4f9a292c17072a2

示例

正常返回示例

JSON格式

{
  "RequestId": "2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1",
  "Clusters": [
    {
      "Components": "{}",
      "ClusterId": "i137590131672134915401",
      "ClusterName": "cnp_test_cluster",
      "OperatingState": "initializing",
      "TaskId": "i156365121663149566024",
      "ClusterType": "AckEdgePro",
      "NodeCount": 12,
      "NodeGroupCount": 2,
      "CreateTime": "1672134938",
      "UpdateTime": "1672134968",
      "ClusterDescription": "测试集群",
      "ResourceGroupId": "rg-aek2ajbjoloa23q",
      "VpcId": "vpc-0jlx4hol2bjboafzmffvd",
      "HpnZone": "B1",
      "ComputingIpVersion": "IPv4"
    }
  ],
  "NextToken": "f4f9a292c17072a2"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-07	OpenAPI 返回结构发生变更	查看变更详情
2023-09-21	OpenAPI 返回结构发生变更	查看变更详情
2023-08-20	OpenAPI 返回结构发生变更	查看变更详情