Query ESA Plan Quotas and Usage via API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the quotas and actual usage of a plan by website ID or plan ID.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The plan ID. You can obtain this value by calling the ListSites operation.	sp-xcdn-96wblslz****
SiteId	integer	No	The website ID. You can obtain this value by calling the ListSites operation.	1232223****
QuotaNames	string	Yes	The quota names in the plan. Separate multiple names with commas (,). You can query up to 10 quota names at a time. Valid values: customHttpCert: the custom certificates. transition_rule: the transform rules. waiting_room: the waiting rooms. https\|rule_quota: the SSL/TLS rules. cache_rules\|rule_quota: the cache rules. configuration_rules\|rule_quota: the configuration rules. redirect_rules\|rule_quota: the redirect rules. compression_rules\|rule_quota: the compression rules. origin_rules\|rule_quota: the origin rules.	customHttpCert

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	85H66C7B-671A-4297-9187-2C4477247A74
InstanceId	string	The plan ID.	sp-xcdn-96wblslz****
Status	string	The plan status. Valid values: online: The plan is active. offline: The plan has expired but is within the grace period. The plan is unavailable in this state. disable: The plan has been released.	online
Quotas	array<object>	The quotas and their actual usage in the plan.
	array<object>	The quota and usage details in the plan.
QuotaName	string	The quota name.	redirect_rules\|rule_quota
QuotaValue	string	The quota value.	10
Usage	string	The quota usage.	3
SiteUsage	array<object>	The quota usage per website associated with the plan.
	object	The quota usage details for a single website.
SiteId	integer	The website ID.	34818329392****
SiteUsage	string	The quota usage of the website.	1
SiteName	string	The website name.	test.top

Examples

Success response

JSON format

{
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "InstanceId": "sp-xcdn-96wblslz****",
  "Status": "online",
  "Quotas": [
    {
      "QuotaName": "redirect_rules|rule_quota",
      "QuotaValue": "10",
      "Usage": "3",
      "SiteUsage": [
        {
          "SiteId": 0,
          "SiteUsage": "1",
          "SiteName": "test.top"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	QuotaNotExist	The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.	The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	NoPermission	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.
400	ErService.HasOpened	You have already activated Edge Routine.	You have already activated Edge Routine.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.
404	UnsupportQuota	Unsupported quota is specified. Check and try again.	Unsupported quota is specified. Check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.