API Schema Upload Quota Reference - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	No	The site ID. You can obtain this ID by calling the ListSites operation.	1159101787****
SiteVersion	integer	No	The site version.	0

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	952ea16b-1f05-4a76-bb32-420282d8****
InstanceId	string	The plan's instance ID.	esa-site-agknce3n****
InstanceUsage	integer	The total number of API schema files uploaded to the plan instance.	10
Usages	array<object>	The usage details for each site.
	object	The usage details for an individual site.
Usage	integer	The number of API schema files uploaded for this site.	0
Id	integer	The site ID.	40000449
Name	string	The site name.	test

Examples

Success response

JSON format

{
  "RequestId": "952ea16b-1f05-4a76-bb32-420282d8****",
  "InstanceId": "esa-site-agknce3n****",
  "InstanceUsage": 10,
  "Usages": [
    {
      "Usage": 0,
      "Id": 40000449,
      "Name": "test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ApiShield.Quota	This website does not have the permission to view API security features.	This website does not have the permission to view API security features.
400	SiteVersion.NotExist	The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.	The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.