调用DescribeClusters查询集群信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeClusters

系统规定参数。取值:DescribeClusters。

ClusterId String gws-rhzlyl5zx3ua****

集群ID。

PageNumber Long 1

页码。

PageSize Long 10

每页的行数。

返回数据

名称 类型 示例值 描述
Clusters Array of Cluster

集群信息列表。

ClusterId String gws-rhzlyl5zx3ua****

集群ID。

CreateTime String 2020-09-17T02:02:25Z

创建时间。

DomainName String example.com
  • gws.s1.standard 集群:返回空值。
  • gws.s1.advanced 集群:关联用户AD域之后,此值对应已关联的用户AD域,例如:example.com。取消关联后,此值为空。
InstanceCount Long 1

集群中的实例个数。

Name String cluster-xxx

集群名称。

NatEip String 192.168.XX.XX

与集群关联的NAT网关所使用的弹性公网IP。

说明 当集群没有与NAT网关关联时,此值为空。
NatId String ngw-uf63l0kkf73ieyf9k****

与集群关联的NAT网关的ID。

说明 当集群没有与NAT网关关联时,此值为空。
SecurityGroup String sg-bp18ny7dvho4g0s7****

安全组ID。

Status String running

集群状态。可能值:

  • creating
  • starting
  • running
  • deleted
  • indebt
VpcId String vpc-bp1vi54o1on2sijpm****

VPC ID。

PageNumber Long 1

页码。

PageSize Long 10

每页行数。

RequestId String 7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A

请求ID。

TotalCount Long 1

集群总数。

示例

请求示例

https://gws.cn-hangzhou.aliyuncs.com/?Action=DescribeClusters
&<公共请求参数>

正常返回示例

XML格式

<DescribeClustersResponse>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A</RequestId>
      <PageNumber>1</PageNumber>
      <Clusters>
            <Status>running</Status>
            <InstanceCount>1</InstanceCount>
            <NatId>ngw-uf63l0kkf73ieyf9k****</NatId>
            <VpcId>vpc-bp1vi54o1on2sijpm****</VpcId>
            <DomainName>example.com</DomainName>
            <ClusterId>gws-rhzlyl5zx3ua****</ClusterId>
            <CreateTime>2020-09-17T02:02:25Z</CreateTime>
            <SecurityGroup>sg-bp18ny7dvho4g0s7****</SecurityGroup>
            <NatEip>192.168.XX.XX</NatEip>
            <Name>cluster-xxx</Name>
      </Clusters>
</DescribeClustersResponse>

JSON格式

{
    "TotalCount": "1",
    "PageSize": "10",
    "RequestId": "7FCC0CD3-53C2-508E-9E1C-39BF14F0E75A",
    "PageNumber": "1",
    "Clusters": [
        {
            "Status": "running",
            "InstanceCount": "1",
            "NatId": "ngw-uf63l0kkf73ieyf9k****",
            "VpcId": "vpc-bp1vi54o1on2sijpm****",
            "DomainName": "example.com",
            "ClusterId": "gws-rhzlyl5zx3ua****",
            "CreateTime": "2020-09-17T02:02:25Z",
            "SecurityGroup": "sg-bp18ny7dvho4g0s7****",
            "NatEip": "192.168.XX.XX",
            "Name": "cluster-xxx"
        }
    ]
}