调用DescribeGatewayCaches可以查询缓存盘信息，包括缓存盘大小、类型等。

调用该接口时，您需要注意：

  • 请确保在使用该接口前，已充分了解缓存盘产品的收费方式和价格。
  • 如果您的网关需要续费，可通过接口返回的续费链接进行续费。

调试

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

请求参数

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

系统规定参数。取值：DescribeGatewayCaches。
GatewayId String 是 gw-000eg44nmxbsfwbvq***

网关ID。

返回数据

名称 类型 示例值 描述
RequestId String 40797B4D-09D9-482E-B163-CCB568BADE35

请求ID。
Success Boolean true

请求是否成功。
Code String 200

状态码。状态码为200表示请求成功。
Message String successful

请求结果描述。
Caches Array

缓存盘信息。
SizeInGB Long 101

缓存盘大小。单位：GB。
Iops Long 2605

IOPS。
CacheId String d-bp1dcnq8zldree6ok***

缓存盘ID。
CacheType String cloud_efficiency

缓存盘类型。可能值：

  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD云盘。
IsUsed Boolean false

是否被使用。
LocalFilePath String /dev/vdb

缓存盘内部设备名。
RenewURL String https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew

续费链接。
ExpiredTime Long 1532510649

到期时间。时间戳为秒（s）。
ExpireStatus Integer 0

是否过期状态。可能值：

  • 0：正常。
  • 1：将要过期。
  • 2：已经过期。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeGatewayCaches
&GatewayId=gw-000eg44nmxbsfwbvq***
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeGatewayCachesResponse>
      <Message>successful</Message>
      <RequestId>40797B4D-09D9-482E-B163-CCB568BADE35</RequestId>
      <Caches>
            <Cache>
                  <SizeInGB>101</SizeInGB>
                  <CacheId>d-bp1dcnq8zldree6o***</CacheId>
                  <ExpireStatus>0</ExpireStatus>
                  <IsUsed>false</IsUsed>
                  <Iops>2608</Iops>
                  <LocalFilePath>/dev/vdb</LocalFilePath>
                  <ExpiredTime>1584288000000</ExpiredTime>
                  <RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidnd***#/renew</RenewURL>
                  <CacheType>cloud_efficiency</CacheType>
            </Cache>
      </Caches>
      <Code>200</Code>
      <Success>true</Success>
</DescribeGatewayCachesResponse>

JSON 格式 

{
    "Message":"successful",
    "RequestId":"40797B4D-09D9-482E-B163-CCB568BADE35",
    "Caches":{
        "Cache":[
            {
                "SizeInGB":101,
                "CacheId":"d-bp1dcnq8zldree6o***",
                "ExpireStatus":0,
                "IsUsed":false,
                "Iops":2608,
                "LocalFilePath":"/dev/vdb",
                "ExpiredTime":"1584288000000",
                "RenewURL":"https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew",
                "CacheType":"cloud_efficiency"
            }
        ]
    },
    "Code":"200",
    "Success":true
}

错误码

HttpCode 错误码 错误信息 描述
400 EmptyGatewayId You must enter a valid ID for the gateway. 网关ID不能为空。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在，请确认输入参数是否正确。
500 InternalError Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket. 内部错误，请重试。如果多次尝试失败，请提交工单。
400 GatewayInUpgrading The gateway is upgrading. Try again later. 网关正在升级中，请稍后再试。
400 GatewayInOperation The gateway is processing requests . Try again later. 网关正在进行操作中，请稍后再试。

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