GetSiteLogDeliveryQuota - - Alibaba Cloud Documentation Center

Queries the remaining quota for delivering a specific category of real-time logs in a website.

Operation description

You can call this operation to query the remaining quota for delivering a specific category of real-time logs in a website within an Alibaba Cloud account. This is essential for monitoring and managing your log delivery capacity to ensure that logs can be delivered to the destination and prevent data loss or latency caused by insufficient quota.

Take note of the following parameters:

``
BusinessType is required. You must specify a log category to obtain the corresponding quota information.
SiteId specifies the ID of a website, which must be a valid integer that corresponds to a website that you configured on Alibaba Cloud.

Response:

If a request is successful, the system returns the remaining log delivery quota (FreeQuota), request ID (RequestId), website ID (SiteId), and log category (BusinessType). You can confirm and record the returned data.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
esa:GetSiteLogDeliveryQuota	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BusinessType	string	Yes	The log category. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: Edge Routine logs. dcdn_log_waf: firewall logs. dcdn_log_ipa: TCP/UDP proxy logs.	dcdn_log_access_l1
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	123456****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4C14840EF0EAAB6D97CDE0C5F6554ACE
FreeQuota	long	The remaining quota.	3
BusinessType	string	The log category. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: Edge Routine logs. dcdn_log_waf: firewall logs. dcdn_log_ipa: TCP/UDP proxy logs.	dcdn_log_access_l1
SiteId	long	The website ID.	123456****

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time	Summary of changes	Operation
2024-09-27	The Error code has changed	View Change Details