调用GetK8sCluster接口获取K8s集群列表_企业级分布式应用服务(EDAS)-阿里云帮助中心

获取容器服务K8s集群或Serverless K8s集群列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadCluster

get

*Cluster

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}

无

请求语法

POST /pop/v5/k8s_clusters HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionTag	string	是	地域。	cn-hangzhou
CurrentPage	integer	否	分页查询时当前显示第几页，默认值为 1。	1
PageSize	integer	否	分页查询时每页显示几条，默认值为 1000。	10
ClusterType	integer	否	K8s 集群类型： 5：容器服务 K8s 集群。 7：自建 K8s 集群。	5
SubClusterType	string	否	集群子类型： Ask：Serverless K8s 集群。 ManagedKubernetes：容器服务 K8s 集群。	Ask

返回参数

名称	类型	描述	示例值
	object	接口响应。
Code	integer	接口状态或 POP 错误码。	200
Message	string	附加信息。	success
RequestId	string	请求 ID。	C3CE915C-0C83-4AA5-8D66-E8BEED62939E
ClusterPage	object	集群分页显示列表。
CurrentPage	integer	分页查询时当前显示第几页，默认值为 1。	1
PageSize	integer	分页查询时每页显示几条，默认值为 1000。	10
TotalSize	integer	显示总页数。	5
ClusterList	object
Cluster	array<object>	集群列表。
	object	集群列表对象。
VpcId	string	VPC ID。	vpc-z1mlwpbjx3e9m
VswitchId	string	交换机 ID。	vsw-bp1uf97**xjxgip**
SubNetCidr	string	子网的网段。	172.20.0.0/16
Mem	integer	内存总量，单位：MB。	2048
RegionId	string	命名空间 ID。	test
CsClusterStatus	string	容器集群运行状态： initial：初始化中。 failed：创建失败。 running：运行中。 updating：更新中。 scaling：扩容中。 removing：移除节点中。 upgrading：升级中。 deleting：删除中。 delete_failed：删除失败。 deleted：已删除（该状态用户不可见）。	running
Cpu	integer	CPU 总核数。	4
NetworkMode	integer	网络类型： 1：经典网络。 2：VPC。	2
CsClusterId	string	容器服务集群 ID。	2ce62869f4d4466b920312315f05****
Description	string	集群描述。	test
ClusterType	integer	集群类型： 2：ECS 集群。 5：容器服务 K8s 集群或 Serverless K8s 集群。	5
ClusterName	string	集群名称。	test
NodeNum	integer	节点数量。	4
ClusterId	string	集群 ID。	81453e4b-4df0-4592-**-b835a2ee**
ClusterImportStatus	integer	集群的导入状态： 0：没有导入。 1：导入成功。 2：导入失败。 3：正在导入。 4：集群已删除。	1
SubClusterType	string	集群子类型： Ask：Serverless K8s 集群。 ManagedKubernetes：容器服务 K8s 集群。	Ask
ClusterStatus	integer	集群运行状态： 1：正常。 2：异常。 3：离线。	1

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "C3CE915C-0C83-4AA5-8D66-E8BEED62939E",
  "ClusterPage": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalSize": 5,
    "ClusterList": {
      "Cluster": [
        {
          "VpcId": "vpc-**z1mlwpbjx3e9m**",
          "VswitchId": "vsw-bp1uf97****xjxgip****",
          "SubNetCidr": "172.20.0.0/16",
          "Mem": 2048,
          "RegionId": "test",
          "CsClusterStatus": "running",
          "Cpu": 4,
          "NetworkMode": 2,
          "CsClusterId": "2ce62869f4d4466b920312315f05****",
          "Description": "test",
          "ClusterType": 5,
          "ClusterName": "test",
          "NodeNum": 4,
          "ClusterId": "81453e4b-4df0-4592-****-b835a2ee****",
          "ClusterImportStatus": 1,
          "SubClusterType": "Ask",
          "ClusterStatus": 1
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	无权限操作

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

变更历史

更多信息，参考变更详情。