All Products
Search

This Product

    Edge Security Acceleration:ListUserRatePlanInstances

    Document Center

    Edge Security Acceleration:ListUserRatePlanInstances

    Last Updated:Jun 26, 2026

    Queries the plan instances purchased by the user and their details.

    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:ListUserRatePlanInstances

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    CheckRemainingSiteQuota

    string

    No

    Specifies whether to filter plan instances that have remaining site quota. Valid values:

    • true: Filters plan instances that have remaining site quota.

    • false: Queries all plan instances under the user.

    true
    Status

    string

    No

    The instance status. Valid values:

    • online: The plan instance is in normal service.

    • offline: The plan instance has expired but has not exceeded the grace period and is not active.

    • disable: The plan instance has been released.

    • overdue: The plan instance has an overdue payment.

    online
    SortBy

    string

    No

    The field by which to sort the results. By default, results are sorted by purchase time. Valid values:

    • CreateTime: purchase time.

    • ExpireTime: expiration time.

    CreateTime
    SortOrder

    string

    No

    The sort order. Default value: desc. Valid values:

    • asc: ascending order.

    • desc: descending order.

    asc
    PageNumber

    integer

    No

    The page number to return in a paged query. Default value: 1. Valid values: 1 to 100000. Settings for paging take effect only when this parameter is specified.

    1
    PageSize

    integer

    No

    The number of entries per page in a paged query. Valid values: 1 to 500. This parameter is used for paging.

    500
    InstanceId

    string

    No

    The plan instance ID. You can obtain the ID by calling the ListSites operation.

    sp-xcdn-96wblslz****
    RemainingExpireDays

    integer

    No

    Queries plan instances whose remaining validity period is within the specified number of days. The value must be a positive integer. Unit: days.

    30
    SubscribeType

    string

    No

    The plan subscription type. Valid values:

    • entranceplan: Free Edition (Chinese mainland)

    • entranceplan_intl: Free Edition (International)

    • basicplan: Basic Edition

    • standardplan: Standard Edition

    • advancedplan: Premium Edition

    • enterpriseplan: Enterprise Edition.

    basicplan
    PlanType

    string

    No

    The plan type. Valid values:

    • normal: fixed-version plan

    • enterprise: Enterprise Edition plan.

    enterprise
    PlanNameEn

    string

    No

    The plan name in English.

    entranceplan

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE
    InstanceInfo

    array<object>

    The plan instances that match the specified conditions under the user.

    array<object>

    The details of the plan instance.

    InstanceId

    string

    The plan instance ID.

    sp-xcdn-96wblslz****
    PlanName

    string

    The plan name associated with the plan instance.

    basic
    PlanType

    string

    The plan type associated with the plan instance. Valid values:

    • normal: fixed-version plan.

    • enterprise: Enterprise Edition plan.

    normal
    SiteQuota

    string

    The site quota for the plan instance.

    1
    ExpireTime

    string

    The expiration time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.

    2026-04-19T11:15:20Z
    Duration

    integer

    The subscription duration of the plan instance. Unit: months.

    3
    CreateTime

    string

    The purchase time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.

    2026-04-19T11:15:20Z
    Sites

    array<object>

    The list of sites bound to the current plan instance.

    object

    The details of the bound site.

    SiteId

    integer

    The site ID.

    123456****
    SiteName

    string

    The site name.

    example.com
    SiteStatus

    string

    The site status. Valid values:

    • pending: The site is pending configuration.

    • active: The site is active.

    • offline: The site is offline.

    • moved: The site has been replaced.

    pending
    Status

    string

    The instance status. Valid values:

    • online: The plan instance is in normal service.

    • offline: The plan instance has expired but has not exceeded the grace period and is not active.

    • disable: The plan instance has been released.

    online
    Coverages

    string

    The acceleration regions to which sites can be bound under this plan instance. Multiple values are separated by commas (,). Valid values:

    • domestic: China or the Chinese mainland.

    • overseas: Global (excluding China or the Chinese mainland).

    • global: Global (including China or the Chinese mainland).

    domestic,overseas
    BillingMode

    string

    The billing method. Valid values:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    PREPAY
    PlanTraffic

    string

    The prepaid Layer 7 acceleration traffic included in the plan, in GB.

    100
    Layer4Traffic

    string

    The prepaid Layer 4 proxy traffic included in the plan, in GB, for the Chinese mainland.

    100
    Layer4TrafficIntl

    string

    The prepaid Layer 4 proxy traffic included in the plan, in GB, outside the Chinese mainland.

    100
    CrossborderTraffic

    string

    The prepaid China network acceleration traffic included in the plan, in GB.

    100
    EdgeRoutineRquest

    string

    The prepaid Edge Routine (ER) requests included in the plan, in units of 10,000.

    100
    StaticRequest

    string

    The prepaid HTTP requests included in the plan, in units of 10,000.

    100
    SmartRoutingRequest

    string

    The prepaid smart routing requests included in the plan, in units of 10,000.

    100
    EdgeWafRequest

    string

    The prepaid WAF requests included in the plan, in units of 10,000.

    100
    DdosInstanceLevel

    string

    If this field is empty, the plan does not include an Anti-DDoS instance. If a value is returned, the plan includes an Anti-DDoS instance. The value is esa_ddos_instance.

    esa_ddos_instance
    DdosBurstableDomesticProtection

    string

    The Anti-DDoS instance specification for the Chinese mainland included in the plan.

    cn_300
    DdosBurstableOverseasProtection

    string

    The Anti-DDoS instance specification outside the Chinese mainland included in the plan.

    overseas_300
    BotInstanceLevel

    string

    If this field is empty, the plan does not include a bot protection instance. If a value is returned, the plan includes a bot protection instance. Valid values:

    • enterprise_bot: Web Edition

    • enterprise_bot_with_app: App Edition.

    enterprise_bot
    BotRequest

    string

    The prepaid bot protection requests included in the plan, in units of 10,000.

    100
    SubscribeType

    string

    The plan subscription type. Valid values:

    • entranceplan: Free Edition (Chinese mainland)

    • entranceplan_intl: Free Edition (International)

    • basicplan: Basic Edition

    • standardplan: Standard Edition

    • advancedplan: Premium Edition

    • enterpriseplan: Enterprise Edition.

    basicplan
    RenewalStatus

    string

    The auto-renewal status. Valid values:

    • nomal: normal

    • auto_renewal: auto-renewal enabled

    • not_renewal: auto-renewal disabled.

    nomal
    RenewalDuration

    integer

    The auto-renewal cycle. Unit: months.

    6
    PageNumber

    integer

    The current page number, which is the same as the PageNumber request parameter.

    1
    PageSize

    integer

    The number of entries per page.

    10
    TotalCount

    integer

    The total number of entries.

    68
    TotalPage

    integer

    The total number of pages.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "PlanName": "basic",
      "PlanType": "normal",
      "SiteQuota": "1",
      "ExpireTime": "2026-04-19T11:15:20Z",
      "Duration": 3,
      "CreateTime": "2026-04-19T11:15:20Z",
      "Sites": [
        {
          "SiteId": 0,
          "SiteName": "example.com",
          "SiteStatus": "pending"
        }
      ],
      "Status": "online",
      "Coverages": "domestic,overseas",
      "BillingMode": "PREPAY",
      "PlanTraffic": "100",
      "Layer4Traffic": "100",
      "Layer4TrafficIntl": "100",
      "CrossborderTraffic": "100",
      "EdgeRoutineRquest": "100",
      "StaticRequest": "100",
      "SmartRoutingRequest": "100",
      "EdgeWafRequest": "100",
      "DdosInstanceLevel": "esa_ddos_instance",
      "DdosBurstableDomesticProtection": "cn_300",
      "DdosBurstableOverseasProtection": "overseas_300",
      "BotInstanceLevel": "enterprise_bot",
      "BotRequest": "100",
      "SubscribeType": "basicplan",
      "RenewalStatus": "nomal",
      "RenewalDuration": 6
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 68,
  "TotalPage": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The specified parameter is invalid. The specified parameter is invalid.
    400 InternalException Failed to call the service. Try again later or contact technical support. Failed to call the service. Try again later or contact technical support.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.