调用DescribeServerlessCluster接口查询Serverless集群详情。

调试

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

请求参数

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

系统规定参数。取值:DescribeServerlessCluster

ZoneId String sdh0b7f4k5f****

实例所属可用区ID,可调用DescribeInstances接口获取。

ClusterId String hb-bp16f1441y6p2****

集群ID,系统生成的唯一标识码。可调用DescribeInstances接口获取。

返回数据

名称 类型 示例值 描述
VpcId String vpc-bp120k6ixs4eoghz****

实例所属的专有网络ID。

Status String ACTIVATION

当前状态:

  • CREATING:创建中。
  • ACTIVATION:运行中
  • DELETING:删除中。
  • RESTARTING:重启中。
InnerEndpoint String https://sh-wz91452kg946i****-lindorm-serverless-in.lindorm.rds.aliyuncs.com:443

内部地址。

CreateTime String 2019-10-12T14:40:46

集群创建时间。

PayType String Postpaid

付费类型:

  • Prepaid:预付费。
  • Postpaid:后付费。
MainVersion String 2.0.8

主版本。

LockMode String 过期

集群锁定类型。

说明 该参数无返回值。
HasUser String false

是否有用户。

  • true:有用户。
  • false:无用户。
HaType String false

是否高可用:

  • true:高可用。
  • false:非高可用。
RequestId String 89F81C30-320B-4550-91DB-C37C81D2358F

请求ID。

UpdateStatus String NO

小版本升级的状态:

  • YES:可以升级。
  • NO:不可以升级。
  • PENDING:升级中。
ReserverMaxQpsNum String 100

预留最大QPS大小。

InstanceName String test

集群名称。

OuterEndpoint String https://sh-wz91452kg946i****-lindorm-serverless.lindorm.rds.aliyuncs.com:443

外部地址。

CuSize String 150

CU大小。

ExpireTime String 2019-10-12T14:40:46

失效时间。

ReserverMinQpsNum String 50

预留最小QPS大小。

AutoRenew String false

是否续费:

  • true:续费。
  • false:不续费。
DiskSize String 200

节点磁盘大小,单位为G。

InstanceId String hb-bp16f1441y6p2****

集群ID。

IsDeletionProtection String true

是否开启保护。

RegionId String cn-hangzhou

实例所属地域ID。

VSwitchId String vsw-bp191ipotqf****

虚拟交换机ID。

ClusterType String single

集群类型。

  • Cluster:集群版。
  • Single:单节点。
ResourceGroupId String rg-fjm2d4v7sf****

资源所在的资源组ID。

ZoneId String cn-hangzhou-f

实例所属可用区ID。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeServerlessCluster
&ClusterId=hb-bp16f1441y6p2****
&ZoneId=1
&<公共请求参数>

正常返回示例

XML格式

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

<UpdateStatus>string</UpdateStatus>
<ResourceGroupId>rg-fjm2d4v7sf****</ResourceGroupId>
<OuterEndpoint>string</OuterEndpoint>
<AutoRenew>false</AutoRenew>
<ReserverMinQpsNum>50</ReserverMinQpsNum>
<IsDeletionProtection>true</IsDeletionProtection>
<DiskSize>200</DiskSize>
<ReserverMaxQpsNum>100</ReserverMaxQpsNum>
<CuSize>150</CuSize>
<InnerEndpoint>string</InnerEndpoint>
<Status>ACTIVATION</Status>
<MainVersion>2.0.8</MainVersion>
<ZoneId>cn-hangzhou-f</ZoneId>
<RequestId>89F81C30-320B-4550-91DB-C37C81D2358F</RequestId>
<InstanceId>hb-bp16f1441y6p2****</InstanceId>
<HasUser>false</HasUser>
<CreateTime>2019-10-12T14:40:46</CreateTime>
<VSwitchId>vsw-bp191ipotqf****</VSwitchId>
<HaType>false</HaType>
<PayType>Postpaid</PayType>
<LockMode>过期</LockMode>
<ClusterType>single</ClusterType>
<InstanceName>test</InstanceName>
<VpcId>vpc-bp120k6ixs4eoghz****</VpcId>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2019-10-12T14:40:46</ExpireTime>

JSON格式

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

{
  "UpdateStatus" : "string",
  "ResourceGroupId" : "rg-fjm2d4v7sf****",
  "OuterEndpoint" : "string",
  "AutoRenew" : "false",
  "ReserverMinQpsNum" : "50",
  "IsDeletionProtection" : "true",
  "DiskSize" : "200",
  "ReserverMaxQpsNum" : "100",
  "CuSize" : "150",
  "InnerEndpoint" : "string",
  "Status" : "ACTIVATION",
  "MainVersion" : "2.0.8",
  "ZoneId" : "cn-hangzhou-f",
  "RequestId" : "89F81C30-320B-4550-91DB-C37C81D2358F",
  "InstanceId" : "hb-bp16f1441y6p2****",
  "HasUser" : "false",
  "CreateTime" : "2019-10-12T14:40:46",
  "VSwitchId" : "vsw-bp191ipotqf****",
  "HaType" : "false",
  "PayType" : "Postpaid",
  "LockMode" : "过期",
  "ClusterType" : "single",
  "InstanceName" : "test",
  "VpcId" : "vpc-bp120k6ixs4eoghz****",
  "RegionId" : "cn-hangzhou",
  "ExpireTime" : "2019-10-12T14:40:46"
}

错误码

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