All Products
Search
Document Center

Edge Security Acceleration:ListInstanceQuotasWithUsage

Last Updated:Nov 15, 2025

Queries quotas and the actual usage in a plan based on the website or plan ID.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListInstanceQuotasWithUsagelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The plan ID, which can be obtained by calling the ListSites operation.

sp-xcdn-96wblslz****
SiteIdlongNo

The website ID, which can be obtained by calling the ListSites operation.

1232223****
QuotaNamesstringYes

The quota names in the plan. Separate the quota 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 parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

85H66C7B-671A-4297-9187-2C4477247A74
InstanceIdstring

The plan ID.

sp-xcdn-96wblslz****
Statusstring

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
Quotasarray<object>

The quotas and their actual usage in the plan.

Itemobject

The details of the quota and the quota usage in the plan.

QuotaNamestring

The quota name.

redirect_rules|rule_quota
QuotaValuestring

The quota value.

10
Usagestring

The quota usage.

3
SiteUsagearray<object>

The usage of the quota in each website associated with the plan.

Itemobject

The usage details of the quota in a single website.

SiteIdlong

The website ID.

34818329392****
SiteUsagestring

The quota usage of the website.

1
SiteNamestring

The website name.

test.top

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
400QuotaNotExistThe 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.
400InstanceNotExistThe 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.
400NoPermissionYou 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.
400ErService.HasOpenedYou have already activated Edge Routine.You have already activated Edge Routine.
403Site.NotExistThe 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.
404SiteNotFoundThe website does not exist or does not belong to you.The website does not exist or does not belong to you.
404UnsupportQuotaUnsupported quota is specified. Check and try again.Unsupported quota is specified. Check and try again.

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

Change history

Change timeSummary of changesOperation
2024-10-15The Error code has changedView Change Details
2024-10-10The Error code has changedView Change Details