调用GetK8sCluster接口获取容器服务K8s集群或Serverless K8s集群列表。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v5/k8s_clusters HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
RegionTag String Query cn-hangzhou

地域

CurrentPage Integer Query 1

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

PageSize Integer Query 10

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

ClusterType Integer Query 5

集群类型

返回数据

名称 类型 示例值 描述
Code Integer 200

接口状态或POP错误码

Message String success

附加信息

RequestId String C3CE915C-0C83-4AA5-8D66-E8BEED62939E

请求ID

ClusterPage Object

集群分页显示列表

CurrentPage Integer 1

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

PageSize Integer 10

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

TotalSize Integer 5

显示总页数

ClusterList Array of Cluster

集群列表

Cluster
VpcId String vpc-**z1mlwpbjx3e9m**

VPC ID

VswitchId String vsw-bp1uf97****xjxgip****

交换机ID

SubNetCidr String 172.20.0.0/16

子网的网段

Mem Integer 2048

内存总量,单位:MB。

RegionId String test

命名空间ID

CsClusterStatus String running

容器集群运行状态:

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

CPU总核数

NetworkMode Integer 2

网络类型:

  • 1:经典网络
  • 2:VPC
CsClusterId String 2ce62869f4d4466b920312315f05****

容器服务集群ID

Description String test

集群描述

ClusterType Integer 5

集群类型:

  • 2:ECS集群
  • 5:容器服务K8s集群或Serverless K8s集群
ClusterStatus Integer 1

集群运行状态:

  • 1:正常
  • 2:异常
  • 3:离线
ClusterName String test

集群名称

NodeNum Integer 4

节点数量

ClusterId String 81453e4b-4df0-4592-****-b835a2ee****

集群ID

ClusterImportStatus Integer 1

集群的导入状态:

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

示例

请求示例

POST /pop/v5/k8s_clusters?RegionTag=cn-hangzhou&CurrentPage=1&PageSize=10&ClusterType=5 HTTP/1.1
Host:edas.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>C3CE915C-0C83-4AA5-8D66-E8BEED62939E</RequestId>
<Message>success</Message>
<ClusterPage>
    <ClusterList>
        <Cluster>
            <ClusterImportStatus>1</ClusterImportStatus>
            <NodeNum>3</NodeNum>
            <ClusterId>6cd7d5d3-2c7b-48be-a874-3e746708****</ClusterId>
            <Cpu>0</Cpu>
            <ClusterType>5</ClusterType>
            <NetworkMode>2</NetworkMode>
            <CsClusterId>c0b7a530b96d24b46bd02da2316c****</CsClusterId>
            <VswitchId>vsw-bp1y77ga5pz9lianh****</VswitchId>
            <VpcId>vpc-bp1jmhiplgziujhw0****</VpcId>
            <Mem>0</Mem>
            <ClusterName>gray</ClusterName>
            <SubNetCidr>172.20.0.0/16</SubNetCidr>
            <RegionId>cn-hangzhou:test</RegionId>
            <CsClusterStatus>running</CsClusterStatus>
            <ClusterStatus>0</ClusterStatus>
        </Cluster>
    </ClusterList>
    <PageSize>17</PageSize>
    <CurrentPage>0</CurrentPage>
    <TotalSize>17</TotalSize>
</ClusterPage>
<Code>200</Code>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C3CE915C-0C83-4AA5-8D66-E8BEED62939E",
  "Message" : "success",
  "ClusterPage" : {
    "ClusterList" : {
      "Cluster" : [ {
        "ClusterImportStatus" : 1,
        "NodeNum" : 3,
        "ClusterId" : "6cd7d5d3-2c7b-48be-a874-3e746708****",
        "Cpu" : 0,
        "ClusterType" : 5,
        "NetworkMode" : 2,
        "CsClusterId" : "c0b7a530b96d24b46bd02da2316c****",
        "VswitchId" : "vsw-bp1y77ga5pz9lianh****",
        "VpcId" : "vpc-bp1jmhiplgziujhw0****",
        "Mem" : 0,
        "ClusterName" : "gray",
        "SubNetCidr" : "172.20.0.0/16",
        "RegionId" : "cn-hangzhou:test",
        "CsClusterStatus" : "running",
        "ClusterStatus" : 0
      } ]
    },
    "PageSize" : 17,
    "CurrentPage" : 0,
    "TotalSize" : 17
  },
  "Code" : 200
}

错误码

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

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