文档

DescribeGWSClusters - 查询可视化服务集群信息

更新时间:

调用DescribeGWSClusters查询可视化服务集群信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

可视化服务集群 ID。

gws-rhz99q8rc****
PageNumberinteger

当前页码。

起始值:1

默认值:1

1
PageSizeinteger

每页显示的条数。取值范围:1~50

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

当前页条数。

10
PageNumberinteger

当前页码。

1
RequestIdstring

请求 ID。

2777461A-E45E-42F8-8E67-0EBF132E93E0
CallerTypestring

账号类型。可能值:

  • sub:RAM 用户
  • parent:阿里云账号
sub
TotalCountinteger

列表条目总数。

1
Clustersobject []

可视化集群信息列表。

VpcIdstring

VPC ID。

vpc-bp1nq8oshqudln3hy****
Statusstring

可视化集群状态。可能值:

  • creating:创建中
  • starting:启动中
  • running:运行中
  • deleted:已删除
running
InstanceCountinteger

可视化实例数目。

3
CreateTimestring

可视化集群创建时间。

2019-05-15T06:05:40.000Z
ClusterIdstring

可视化集群 ID。

gws-rhz99q8rc****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "2777461A-E45E-42F8-8E67-0EBF132E93E0",
  "CallerType": "sub",
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfo": [
      {
        "VpcId": "vpc-bp1nq8oshqudln3hy****",
        "Status": "running",
        "InstanceCount": 3,
        "CreateTime": "2019-05-15T06:05:40.000Z",
        "ClusterId": "gws-rhz99q8rc****"
      }
    ]
  }
}

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "2777461A-E45E-42F8-8E67-0EBF132E93E0",
  "CallerType": "sub",
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfo": [
      {
        "VpcId": "vpc-bp1nq8oshqudln3hy****",
        "Status": "running",
        "InstanceCount": 3,
        "CreateTime": "2019-05-15T06:05:40.000Z",
        "ClusterId": "gws-rhz99q8rc****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsInvalid param: %s-
406AliyunError其他云产品接口请求失败
407NotAuthorized此请求未获得RAM授权
500UnknownError未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

  • 本页导读 (1)
文档反馈