DescribeGatewayCaches - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Queries information about cache disks, such as size and type.

Operation description

Description

Before you call this operation, note the following:

Make sure that you understand the billing methods and prices of Cloud Storage Gateway.
You can use the renewal link that is returned by this operation to renew your gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DescribeGatewayCaches

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq***

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The message that is returned.	successful
RequestId	string	The ID of the request.	40797B4D-09D9-482E-B163-CCB568BADE35
Caches	object
Cache	array<object>	The information about the cache disks.
	object
PerformanceLevel	string	The performance level of the Enhanced SSD (ESSD). Valid values: PL1 PL2 PL3
SizeInGB	integer	The size of the cache disk. Unit: GB.	101
BuyURL	string	The link to purchase the cache disk.
Iops	integer	The input/output operations per second (IOPS) of the cache disk.	2605
CacheId	string	The ID of the cache disk.	d-bp1dcnq8zldree6ok***
CacheType	string	The type of the cache disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.	cloud_efficiency
IsUsed	boolean	Indicates whether the cache disk is used.	false
ExpiredTime	integer	The UNIX timestamp when the cache disk expires. Unit: seconds.	1532510649
LocalFilePath	string	The internal name of the device.	/dev/vdb
IsNoPartition	boolean	Indicates whether the cache disk has a partition. A value of true indicates that the cache disk does not have a partition.
SubscriptionInstanceId	string	The ID of the subscription instance.
ExpireStatus	integer	The expiration status. Valid values: 0: The cache disk is Normal. 1: The cache disk is about to expire. 2: The cache disk has expired.	0
RenewURL	string	The renewal link.	https://common-buy-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidnd***#/renew
IsDirectExpand	string	Indicates whether online scale-out is supported. A value of true indicates that online scale-out is supported.
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The gateway is upgrading. Try again later.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. Try again later.
500	InternalError	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.