ListPostpaidRatePlanInstances - Edge Security Acceleration

Queries the list of pay-as-you-go plan instances.

Operation description

Queries the list of pay-as-you-go plan instances under your account. You can filter and sort the results by multiple conditions.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CheckRemainingSiteQuota	string	No	Specifies whether to check for remaining site quota. Valid values: true: Queries instances that have remaining site quota. false: Does not filter by this condition.	true
SortBy	string	No	The field by which to sort the results. Valid values: CreateTime: sorts by creation time. Valid values: CreateTime : Sorts by creation time.	CreateTime
SortOrder	string	No	The sort order. Valid values: asc: ascending order desc: descending order. Valid values: asc : ascending order. desc : descending order.	desc
PageNumber	integer	No	The page number for paging. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for paging. Valid values: 1 to 500.	12
Status	string	No	The instance status. Valid values: online: Normal. overdue: Overdue payment. disable: Released. Valid values: overdue : Overdue payment. disable : Released. online : Normal.	online
InstanceId	string	No	The instance ID. Use this parameter to query a specific instance.	sp-dps-xxxxxx
UnrelatedType	string	No	Specifies whether the instance has purchased additional bot or DDoS protection. Valid values: bot : Bot protection. ddos : DDoS protection.	bot

Response elements

Element	Type	Description	Example
	object	The response information.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A123425345
InstanceInfo	array<object>	The list of instance information.
	array<object>	The details of a plan instance.
InstanceId	string	The instance ID.	sp-xcdn-96wblslz****
PlanName	string	The plan name in English.	basic
PlanType	string	The plan type of the instance. Valid values: normal: Fixed plan. enterprise: Enterprise plan.	normal
SiteQuota	string	The site quota.	1
CreateTime	string	The time when the instance was created. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2026-04-19T11:15:20Z
Sites	array<object>	The list of sites.
	object	The list of sites that are associated with the plan instance.
SiteId	integer	The ID of the site.	123456****
SiteName	string	The name of the site.	example.com
SiteStatus	string	The status of the site. Valid values: `pending`: The site is awaiting configuration. `active`: The site is active. `offline`: The site is offline. `moved`: The site has been replaced.	pending
Status	string	The instance status.	online
Coverages	string	The acceleration regions to which the instance can bindable sites. Multiple values are separated by commas (,). Valid values: domestic: the Chinese mainland. overseas: global (excluding the Chinese mainland). global: global (including the Chinese mainland).	domestic
BillingMethod	string	The billable methods. Valid values: dps_month95: monthly 95th percentile billing.	SUBSCRIBE
PlanNameCn	string	The plan name in Chinese.	测试套餐
BillingMode	string	The billing mode. Valid values: POSTPAY: pay-as-you-go.	POSTPAY
ExpectedUpdateTime	string	The scheduled specification change time. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2026-04-19T11:15:20Z
PageNumber	integer	The current page number, which is the same as the PageNumber request parameter.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of records.	1
TotalPage	integer	The total number of pages.	2

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "PlanName": "basic",
      "PlanType": "normal",
      "SiteQuota": "1",
      "CreateTime": "2026-04-19T11:15:20Z",
      "Sites": [
        {
          "SiteId": 0,
          "SiteName": "example.com",
          "SiteStatus": "pending"
        }
      ],
      "Status": "online",
      "Coverages": "domestic",
      "BillingMethod": "SUBSCRIBE",
      "PlanNameCn": "测试套餐",
      "BillingMode": "POSTPAY",
      "ExpectedUpdateTime": "2026-04-19T11:15:20Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "TotalPage": 2
}

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.