调用DescribeGatewayCaches查询缓存盘信息-云存储网关-阿里云

查询缓存盘信息，包括缓存盘大小、类型等。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayCaches

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbvq***

返回参数

名称	类型	描述	示例值
	object
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	40797B4D-09D9-482E-B163-CCB568BADE35
Caches	object
Cache	array<object>	缓存盘信息。
	object
PerformanceLevel	string	ESSD 云盘性能等级。可能值： PL1 PL2 PL3	PL1
SizeInGB	integer	缓存盘大小。单位：GB。	100
BuyURL	string	缓存盘购买链接。	https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy
Iops	integer	缓存盘 IOPS。	2605
CacheId	string	缓存盘 ID。	d-bp1dcnq8zldree6ok***
CacheType	string	缓存盘类型。可能值： cloud_efficiency：高效云盘。 cloud_ssd：SSD 云盘。 cloud_essd：ESSD 云盘。	cloud_efficiency
IsUsed	boolean	是否被使用。	false
ExpiredTime	integer	到期时间戳，单位为秒（s）。	1532510649
LocalFilePath	string	缓存盘内部设备名。	/dev/vdb
IsNoPartition	boolean	是否有分区。true 表示没有。	true
SubscriptionInstanceId	string	付费实例 ID。	ca-000bq2fkzol56575***
ExpireStatus	integer	是否过期状态。可能值： 0：正常。 1：将要过期。 2：已经过期。	0
RenewURL	string	续费链接。	https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew
IsDirectExpand	string	是否支持在线扩容。true 表示支持。	true
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "Message": "successful",
  "RequestId": "40797B4D-09D9-482E-B163-CCB568BADE35",
  "Caches": {
    "Cache": [
      {
        "PerformanceLevel": "PL1",
        "SizeInGB": 100,
        "BuyURL": "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy",
        "Iops": 2605,
        "CacheId": "d-bp1dcnq8zldree6ok***",
        "CacheType": "cloud_efficiency",
        "IsUsed": false,
        "ExpiredTime": 1532510649,
        "LocalFilePath": "/dev/vdb",
        "IsNoPartition": true,
        "SubscriptionInstanceId": "ca-000bq2fkzol56575***",
        "ExpireStatus": 0,
        "RenewURL": "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew",
        "IsDirectExpand": "true"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
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.	网关不存在，请确认输入参数是否正确。
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	网关正在升级中，请稍后再试。
400	GatewayInOperation	The gateway is processing requests . Try again later.	网关正在进行操作中，请稍后再试。
500	InternalError	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	内部错误，请重试。如果多次尝试失败，请提交工单。

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

变更历史

更多信息，参考变更详情。