ListCacheReserveInstances - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query Cache Reserve Instance List

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListCacheReserveInstances	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The status of the cache reserve instance. Valid values: online: The instance is in service. offline: The instance has expired within an allowable period. In this state, it is unavailable. disable: The instance has been released. overdue: The instance has been stopped due to overdue payments.	online
SortBy	string	No	The criterion by which you want to sort the queried instances. Valid values: ExpireTime CreateTime	ExpireTime
SortOrder	string	No	The order by which you want to sort the queried instances. Valid values: asc desc	desc
PageNumber	integer	No	Page number.	1
PageSize	integer	No	Page size. Range: 1~500, default is 500.	20
InstanceId	string	No	Instance ID.	sp-xcdn-96wblslz****

Response parameters

Parameter	Type	Description	Example
	object	Details of the cache reserve instances.
RequestId	string	Request ID.	65C66B7B-671A-8297-9187-2R5477247B76
InstanceInfo	array<object>	The cache reserve instances.
Item	object	Details of the cache reserve instance.
InstanceId	string	Instance ID.	sp-xcdn-96wblslz****
ExpireTime	string	Instance expiration time.	2024-10-05T16:00:00Z
Duration	integer	Duration of the instance purchase, unit: months.	3
CreateTime	string	Instance purchase time.	2024-04-12T05:41:51Z
Status	string	The status of the cache reserve instance. Valid values: online: The instance is in service. offline: The instance has expired within an allowable period. In this state, it is unavailable. disable: The instance has been released. overdue: The instance has been stopped due to overdue payments.	online
CacheReserveRegion	string	Cache reserve usage region.	HK
CacheReserveCapacity	long	Cache reserve capacity. Unit: GB.	512000
PageNumber	integer	Page number. Default value: 1.	1
PageSize	integer	Page size, default 500, range: 1~500.	500
TotalCount	integer	Total count.	16
TotalPage	integer	Total pages.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "ExpireTime": "2024-10-05T16:00:00Z",
      "Duration": 3,
      "CreateTime": "2024-04-12T05:41:51Z",
      "Status": "online",
      "CacheReserveRegion": "HK",
      "CacheReserveCapacity": 512000,
      "ChargeType": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 500,
  "TotalCount": 16,
  "TotalPage": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-21	The Error code has changed. The response structure of the API has changed	View Change Details