GetCertificateQuota - Query free certificate quota and usage | ESA API - Edge Security Acceleration

Queries the quota and usage of free certificates.

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

list

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to query the site ID.	1234567890123
Type	string	Yes	The certificate quota type.	free

Response elements

Element	Type	Description	Example
	object	Schema of Response
Quota	integer	The free certificate quota.	10
QuotaUsage	integer	The free certificate quota usage.	5
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Type	string	The certificate quota type.	free
SiteCount	integer	The number of sites.	2
SiteUsage	array<object>	The list of site usage details.
	object	The site usage details.
SiteId	string	The site ID.	165929521496928
SiteName	string	The site name.	example.com
SiteUsage	integer	The site usage.	5

Examples

Success response

JSON format

{
  "Quota": 10,
  "QuotaUsage": 5,
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Type": "free",
  "SiteCount": 2,
  "SiteUsage": [
    {
      "SiteId": "165929521496928",
      "SiteName": "example.com ",
      "SiteUsage": 5
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
400	QuotaCheckFailed	Failed to check free certificate Quota, please try again later.	Failed to check free certificate Quota, please try again later.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time parameter you entered is invalid. Check the parameter value and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token you entered is invalid. Please check and enter the correct token and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.