ListUserRatePlanInstances - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the plans that you purchased and the details of the plans.

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:ListUserRatePlanInstances	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CheckRemainingSiteQuota	string	No	Specifies whether to query only the plans that have remaining quota for associating websites. Valid values: true: queries only the plans that have remaining quota for associating websites. false: queries all plans in your account.	true
Status	string	No	The plan status. Valid values: online: The plan is in service. offline: The plan has expired within an allowable period. In this state, the plan is unavailable. disable: The plan is released. overdue: The plan is stopped due to overdue payments.	online
SortBy	string	No	The sorting field. By default, the queried plans are sorted by purchase time. Valid values: CreateTime: the time when the plans were purchased. ExpireTime: the time when the plans expire.	CreateTime
SortOrder	string	No	The order in which you want to sort the query results. Default value: desc. Valid values: asc: in ascending order. desc: in descending order.	asc
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	500
InstanceId	string	No	The plan ID, which can be obtained by calling the ListSites operation.	sp-xcdn-96wblslz****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE
InstanceInfo	array<object>	The queried plans.
Item	object	The details of the plan.
InstanceId	string	The plan ID.	sp-xcdn-96wblslz****
PlanName	string	The plan name.	basic
PlanType	string	The plan type. Valid values: normal enterprise	normal
SiteQuota	string	The maximum number of websites that can be associated with the plan.	1
ExpireTime	string	The time when the plan expires.	YYYY-MM-DDThh:mm:ssZ
Duration	integer	The subscription duration of the plan. Unit: month.	3
CreateTime	string	The time when the plan was purchased.	YYYY-MM-DDThh:mm:ssZ
Sites	array<object>	The websites that have been associated with the plan.
Item	object	The details of the associated website.
SiteId	long	The website ID.	123456****
SiteName	string	The website name.	example.com
SiteStatus	string	The website status. Valid values: pending: The website is to be configured. active: The website is active. offline: The website is suspended. moved: The website has been added and verified by another Alibaba Cloud account.	pending
Status	string	The plan status. Valid values: online: The plan is in service. offline: The plan has expired within an allowable period. In this state, the plan is unavailable. disable: The plan is released.	online
Coverages	string	The service locations for the websites that can be associated with the plan. Multiple values are separated by commas (,). Valid values: domestic: the Chinese mainland. overseas: outside the Chinese mainland. global: global.	domestic,overseas
BillingMode	string	The billing method. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	PREPAY
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	68
TotalPage	integer	The total number of pages returned.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "PlanName": "basic",
      "PlanType": "normal",
      "SiteQuota": "1",
      "ExpireTime": "YYYY-MM-DDThh:mm:ssZ ",
      "Duration": 3,
      "CreateTime": "YYYY-MM-DDThh:mm:ssZ ",
      "Sites": [
        {
          "SiteId": 0,
          "SiteName": "example.com",
          "SiteStatus": "pending"
        }
      ],
      "Status": "online",
      "Coverages": "domestic,overseas",
      "BillingMode": "PREPAY",
      "PlanTraffic": "",
      "Layer4Traffic": "",
      "Layer4TrafficIntl": "",
      "CrossborderTraffic": "",
      "EdgeRoutineRquest": "",
      "StaticRequest": "",
      "SmartRoutingRequest": "",
      "EdgeWafRequest": "",
      "DdosInstanceLevel": "",
      "DdosBurstableDomesticProtection": "",
      "DdosBurstableOverseasProtection": "",
      "BotInstanceLevel": ""
    }
  ],
  "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.

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

Change history

Change time	Summary of changes	Operation
2025-02-12	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2025-01-10	The Error code has changed. The response structure of the API has changed	View Change Details
2024-11-28	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-11-12	The Error code has changed. The response structure of the API has changed	View Change Details