描述集群信息

调试

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

请求参数

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

Action:

  • DescribeClusters
ClusterId String gws-xxx

集群 id

PageNumber Long 1

页码

PageSize Long 10

每页的行数

返回数据

名称 类型 示例值 描述
Clusters

集群信息列表。

ClusterId String gws-xxx

集群 id。

CreateTime String Wed Sep 25 16:17:39 CST 2019

创建时间。

InstanceCount Long 1

集群中的实例个数。

Name String cluster-xxx

集群名称。

SecurityGroup String sg-xxx

安全组 id。

Status String running

集群状态:

  • creating
  • starting
  • running
  • deleted
  • indebt
VpcId String vpc-xxx

VPC id。

PageNumber Long 1

页码。

PageSize Long 10

每页行数。

RequestId String XXXX-XXXX

请求 id。

TotalCount Long 1

集群总数。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeClusters
&<公共请求参数>

正常返回示例

XML 格式

<Clusters>
    <ClusterId>gws-xxx</ClusterId>
    <CreateTime>Wed Sep 25 16:17:39 CST 2019</CreateTime>
    <Name>cluster-xxx</Name>
    <SecurityGroup>sg-xxx</SecurityGroup>
    <Status>running</Status>
    <VpcId>vpc-xxx</VpcId>
</Clusters>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RequestId>XXXX-XXXX</RequestId>
<TotalCount>1</TotalCount>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"Clusters":[
		{
			"Name":"cluster-xxx",
			"Status":"running",
			"SecurityGroup":"sg-xxx",
			"ClusterId":"gws-xxx",
			"CreateTime":"Wed Sep 25 16:17:39 CST 2019",
			"VpcId":"vpc-xxx"
		}
	],
	"PageSize":10,
	"RequestId":"XXXX-XXXX"
}

错误码

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