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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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: sorted by creation time Valid values: CreateTime : sorted 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 queries. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for paging queries. 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. Specify 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 edition plan. enterprise: Enterprise edition plan.	normal
SiteQuota	string	The site quota.	1
CreateTime	string	The time when the instance was created. The time follows 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 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 activated. 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 sites can be associated with this instance. 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 billing method. Valid values: dps_month95: Monthly 95th Percentile.	SUBSCRIBE
PlanNameCn	string	The plan name in Chinese.	test-plan
BillingMode	string	The billing mode. Valid values: POSTPAY: pay-as-you-go.	POSTPAY
ExpectedUpdateTime	string	The scheduled specification change time. The time follows 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": "test-plan",
      "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.