调用DescribeColdStorage获取实例的冷存储信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeColdStorage。

ClusterId String 是 ld-bp1uoihlf82e8****

目标实例ID，可调用DescribeInstances接口获取。

返回数据

名称 类型 示例值 描述
ClusterId String ld-bp1uoihlf82e8****

实例ID。
ColdStorageSize String 800

冷存储的总存储容量，单位为GB。

说明 当OpenStatus返回值为open时才会返回此参数。
ColdStorageType String BdsColdStorage

冷存储类型，新创建的BDS实例冷存储类型为BdsColdStorage，其他默认不返回此参数。

ColdStorageUseAmount String 20.00

冷存储空间的使用量，单位为GB。

说明 当OpenStatus返回值为open时才会返回此参数。
ColdStorageUsePercent String 20.00

冷存储空间的使用率，单位为%。

说明 当OpenStatus返回值为open时才会返回此参数。
OpenStatus String open

冷存储开启状态，返回值：

  • open： 已开启。
  • close：未开启。
PayType String POSTPAY

实例的付费类型，返回值：

  • PREPAY ：包年包月（预付费）。
  • POSTPAY：按量付费（后付费）。
RequestId String DCB9479E-F05F-4D1C-AFB7-C639B87764B7

请求ID。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeColdStorage
&ClusterId=ld-bp1uoihlf82e8****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeColdStorageResponse>
  <ColdStorageUsePercent>20.00</ColdStorageUsePercent>
  <ColdStorageSize>800</ColdStorageSize>
  <RequestId>DCB9479E-F05F-4D1C-AFB7-C639B87764B7</RequestId>
  <ClusterId>ld-bp1uoihlf82e8****</ClusterId>
  <ColdStorageUseAmount>20.00</ColdStorageUseAmount>
  <PayType>POSTPAY</PayType>
  <OpenStatus>open</OpenStatus>
</DescribeColdStorageResponse>

JSON格式 

{
    "ColdStorageUsePercent":"20.00",
    "ColdStorageSize":"800",
    "RequestId":"DCB9479E-F05F-4D1C-AFB7-C639B87764B7",
    "ClusterId":"ld-bp1uoihlf82e8****",
    "ColdStorageUseAmount":"20.00",
    "PayType":"POSTPAY",
    "OpenStatus":"open"
}

错误码

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