DescribeGatewayCaches - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Usage notes

When you call the operation, take note of the following information:

You fully understand the billing methods and pricing of Cloud Storage Gateway (CSG).
You can renew the gateway at the URL that is returned in the response.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeGatewayCaches	The operation that you want to perform. Set the value to DescribeGatewayCaches.
GatewayId	String	Yes	gw-000eg44nmxbsfwbvq***	The gateway ID.

Response parameters

Parameter	Type	Example	Description
Message	String	successful	The description of the request result.
RequestId	String	40797B4D-09D9-482E-B163-CCB568BADE35	The request ID.
Caches	Array of Cache		The cache disks.
Cache
PerformanceLevel	String	PL1	The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1 PL2 PL3
SizeInGB	Long	100	The capacity of the cache disk. Unit: GB.
BuyURL	String	https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/buy	The URL of the cache disk buy page.
Iops	Long	2605	The IOPS of the cache disk.
CacheId	String	d-bp1dcnq8zldree6ok***	The ID of the cache disk.
CacheType	String	cloud_efficiency	The type of the cache disk. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD.
IsUsed	Boolean	false	Indicates whether the cache disk is used.
ExpiredTime	Long	1532510649	The expiration time. Unit: seconds.
LocalFilePath	String	/dev/vdb	The path of the cache disk.
IsNoPartition	Boolean	true	Indicates whether the cache disk has no partitions. The value of true indicates that the cache disk has no partitions.
SubscriptionInstanceId	String	ca-000bq2fkzol56575***	The subscription ID.
ExpireStatus	Integer	0	The expiration status. Valid values: 0: The cache disk is far from expiration. 1: The cache disk is about to expire. 2: The cache disk has expired.
RenewURL	String	https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew	The renewal URL.
IsDirectExpand	String	true	Indicates whether online capacity scaling is supported. The value true indicates online capacity scaling is supported.
Code	String	200	The status code. The status code 200 indicates that the request was successful.
Success	Boolean	true	Indicates whether the request was successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGatewayCaches
&GatewayId=gw-000eg44nmxbsfwbvq***
&<Common request parameters>

Sample success responses

XML format

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&amp;orderType=RENEW&amp;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&amp;orderType=RENEW&amp;instanceId=ca-0007va9bnideidnd***#/renew</RenewURL>
        <IsDirectExpand>true</IsDirectExpand>
    </Caches>
    <Code>200</Code>
    <Success>true</Success>
</DescribeGatewayCachesResponse>

JSON format

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
}

Error codes

HttpCode	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	The gateway ID is not specified.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. Check whether the intended gateway is specified.
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The gateway is being upgraded. Try again later.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is being operated on. Try again later.
500	InternalError	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	The error message returned because an internal error had occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, see Service error codes.