调用DescribeGatewayCaches可以查询缓存盘信息,包括缓存盘大小、类型等。
接口说明
调用该接口时,您需要注意:
-
请确保在使用该接口前,已充分了解云存储网关产品的收费方式和价格。
- 如果您的网关需要续费,可通过接口返回的续费链接进行续费。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeGatewayCaches | 系统规定参数。取值:DescribeGatewayCaches。 |
GatewayId | String | 是 | gw-000eg44nmxbsfwbvq*** | 网关ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
Message | String | successful | 请求结果描述。 |
RequestId | String | 40797B4D-09D9-482E-B163-CCB568BADE35 | 请求ID。 |
Caches | Array of Cache | 缓存盘信息。 |
|
Cache | |||
PerformanceLevel | String | PL1 | ESSD云盘性能等级。可能值:
|
SizeInGB | Long | 100 | 缓存盘大小。单位:GB。 |
BuyURL | String | https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy | 缓存盘购买链接。 |
Iops | Long | 2605 | 缓存盘IOPS。 |
CacheId | String | d-bp1dcnq8zldree6ok*** | 缓存盘ID。 |
CacheType | String | cloud_efficiency | 缓存盘类型。可能值:
|
IsUsed | Boolean | false | 是否被使用。 |
ExpiredTime | Long | 1532510649 | 到期时间戳,单位为秒(s)。 |
LocalFilePath | String | /dev/vdb | 缓存盘内部设备名。 |
IsNoPartition | Boolean | true | 是否有分区。true表示没有。 |
SubscriptionInstanceId | String | ca-000bq2fkzol56575*** | 付费实例ID。 |
ExpireStatus | Integer | 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 | 请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeGatewayCaches
&GatewayId=gw-000eg44nmxbsfwbvq***
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeGatewayCachesResponse>
<Message>successful</Message>
<RequestId>40797B4D-09D9-482E-B163-CCB568BADE35</RequestId>
<Caches>
<PerformanceLevel>PL1</PerformanceLevel>
<SizeInGB>100</SizeInGB>
<BuyURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy</BuyURL>
<Iops>2605</Iops>
<CacheId>d-bp1dcnq8zldree6ok***</CacheId>
<CacheType>cloud_efficiency</CacheType>
<IsUsed>false</IsUsed>
<ExpiredTime>1532510649</ExpiredTime>
<LocalFilePath>/dev/vdb</LocalFilePath>
<IsNoPartition>true</IsNoPartition>
<SubscriptionInstanceId>ca-000bq2fkzol56575***</SubscriptionInstanceId>
<ExpireStatus>0</ExpireStatus>
<RenewURL>https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew</RenewURL>
<IsDirectExpand>true</IsDirectExpand>
</Caches>
<Code>200</Code>
<Success>true</Success>
</DescribeGatewayCachesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "successful",
"RequestId" : "40797B4D-09D9-482E-B163-CCB568BADE35",
"Caches" : [ {
"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
}
错误码
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. | 网关不存在,请确认输入参数是否正确。 |
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. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?