GetK8sCluster - 获取K8s集群列表

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadClusterRead
  • EDAS
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}

请求参数

名称类型必填描述示例值
RegionTagstring

地域。

cn-hangzhou
CurrentPageinteger

分页查询时当前显示第几页,默认值为1。

1
PageSizeinteger

分页查询时每页显示几条,默认值为1000。

10
ClusterTypeinteger

K8s集群类型:

  • 5:容器服务K8s集群。
  • 7:自建K8s集群。
5

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

接口状态或POP错误码。

200
Messagestring

附加信息。

success
RequestIdstring

请求ID。

C3CE915C-0C83-4AA5-8D66-E8BEED62939E
ClusterPageobject

集群分页显示列表。

CurrentPageinteger

分页查询时当前显示第几页,默认值为1。

1
PageSizeinteger

分页查询时每页显示几条,默认值为1000。

10
TotalSizeinteger

显示总页数。

5
ClusterListarray

集群列表。

object

集群列表对象。

VpcIdstring

VPC ID。

vpc-**z1mlwpbjx3e9m**
VswitchIdstring

交换机ID。

vsw-bp1uf97****xjxgip****
SubNetCidrstring

子网的网段。

172.20.0.0/16
Meminteger

内存总量,单位:MB。

2048
RegionIdstring

命名空间ID。

test
CsClusterStatusstring

容器集群运行状态:

  • initial:初始化中。
  • failed:创建失败。
  • running:运行中。
  • updating:更新中。
  • scaling:扩容中。
  • removing:移除节点中。
  • upgrading:升级中。
  • deleting:删除中。
  • delete_failed:删除失败。
  • deleted:已删除(该状态用户不可见)。
running
Cpuinteger

CPU总核数。

4
NetworkModeinteger

网络类型:

  • 1:经典网络。
  • 2:VPC。
2
CsClusterIdstring

容器服务集群ID。

2ce62869f4d4466b920312315f05****
Descriptionstring

集群描述。

test
ClusterTypeinteger

集群类型:

  • 2:ECS集群。
  • 5:容器服务K8s集群或Serverless K8s集群。
5
ClusterNamestring

集群名称。

test
NodeNuminteger

节点数量。

4
ClusterIdstring

集群ID。

81453e4b-4df0-4592-****-b835a2ee****
ClusterImportStatusinteger

集群的导入状态:

  • 0:没有导入。
  • 1:导入成功。
  • 2:导入失败。
  • 3:正在导入。
  • 4:集群已删除。
1
SubClusterTypestring

集群子类型:

  • Ask:Serverless K8s 集群。
  • ManagedKubernetes:容器服务 K8s 集群。
Ask
ClusterStatusinteger

集群运行状态:

  • 1:正常。
  • 2:异常。
  • 3:离线。
1

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "C3CE915C-0C83-4AA5-8D66-E8BEED62939E",
  "ClusterPage": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalSize": 5,
    "ClusterList": [
      {
        "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 code错误码错误信息描述
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.无权限操作

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

阿里云首页 企业级分布式应用服务 EDAS 相关技术圈