GetSiteLogDeliveryQuota API Reference - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

You can call this operation to query the remaining quota of the real-time log delivery service for a specific site and business type under a specified Alibaba Cloud account. This is important for monitoring and managing your log delivery capacity to ensure that logs can be smoothly pushed to the destination storage and to prevent data loss or delays caused by insufficient quota.

Parameter notes:

BusinessType is required. Specify the business type to obtain the corresponding quota information.
SiteId must be a valid site ID in integer format and must correspond to the site configured in Alibaba Cloud.

Response:

A successful response returns the delivery quota (FreeQuota), request ID (RequestId), site ID (SiteId), and business type (BusinessType) for confirmation and logging purposes.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessType	string	Yes	The type of real-time logs. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: edge function logs. dcdn_log_waf: security protection logs. dcdn_log_ipa: Layer 4 acceleration logs.	dcdn_log_access_l1
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	123456****

Response elements

Element	Type	Description	Example
	object	The data structure returned upon a successful response.
RequestId	string	The request ID.	4C14840EF0EAAB6D97CDE0C5F6554ACE
FreeQuota	integer	The remaining quota.	3
BusinessType	string	The type of real-time logs. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: edge function logs. dcdn_log_waf: security protection logs. dcdn_log_ipa: Layer 4 acceleration logs.	dcdn_log_access_l1
SiteId	integer	The site ID.	123456****

Examples

Success response

JSON format

{
  "RequestId": "4C14840EF0EAAB6D97CDE0C5F6554ACE",
  "FreeQuota": 3,
  "BusinessType": "dcdn_log_access_l1",
  "SiteId": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
403	RealTimeLog.StatusQuotaError	The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.	The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.