All Products
Search

This Product

    Edge Security Acceleration:ListCacheReserveInstances

    Document Center

    Edge Security Acceleration:ListCacheReserveInstances

    Last Updated:Jul 17, 2026

    Queries the list of cache reserve instances for the current user.

    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 supports 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

    esa:ListCacheReserveInstances

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Status

    string

    No

    The instance status of the cache reserve instance. Valid values:

    • online: Normal service status.

    • offline: The instance expires but has not exceeded the retention period and is unavailable.

    • disable: The instance has been released.

    • overdue: The instance is stopped due to an overdue payment.

    online
    SortBy

    string

    No

    The sort field. Valid values:

    • ExpireTime: sorts by expiration time.

    • CreateTime: sorts by creation time.

    ExpireTime
    SortOrder

    string

    No

    The sort order. Valid values:

    • asc: ascending order.

    • desc: descending order.

    desc
    PageNumber

    integer

    No

    The page number.

    1
    PageSize

    integer

    No

    The number of entries per page. Valid values: 1 to 500. Default value: 500.

    20
    InstanceId

    string

    No

    The instance ID.

    sp-xcdn-96wblslz****

    Response elements

    Element

    Type

    Description

    Example

    object

    The instance query details.

    RequestId

    string

    The request ID.

    65C66B7B-671A-8297-9187-2R5477247B76
    InstanceInfo

    array<object>

    The list of cache reserve instances.

    object

    The details of a cache reserve instance.

    InstanceId

    string

    The instance ID.

    sp-xcdn-96wblslz****
    ExpireTime

    string

    The time when the instance expires.

    2024-10-05T16:00:00Z
    Duration

    integer

    The subscription duration of the instance. Unit: months.

    3
    CreateTime

    string

    The creation time of the instance.

    2024-04-12T05:41:51Z
    Status

    string

    The instance status. Valid values:

    • online: The instance is running normally.

    • offline: The instance has expired but has not exceeded the retention period and is unavailable.

    • disable: The instance has been released.

    • overdue: The instance is stopped due to an overdue payment.

    online
    CacheReserveRegion

    string

    The region where the cache reserve instance is deployed.

    HK
    CacheReserveCapacity

    integer

    The capacity of the cache reserve instance. Unit: GB.

    512000
    ChargeType

    string

    The billing type. Valid values:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    PREPAY
    PageNumber

    integer

    The page number. Default value: 1.

    1
    PageSize

    integer

    The number of entries per page. Default value: 500. Valid values: 1 to 500.

    500
    TotalCount

    integer

    The total number of entries.

    16
    TotalPage

    integer

    The total number of pages.

    1

    Examples

    Success response

    JSON format

    {
  "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": "PREPAY"
    }
  ],
  "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.