DescribeWebAccessLogDispatchStatus

Operation description

This operation is used to query the full log switch status of all domain names that are added to Anti-DDoS Pro for protection.

QPS limit

The QPS limit on this operation is 10 calls per second per user. If the limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a proper frequency.

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

yundun-ddoscoo:DescribeWebAccessLogDispatchStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Pro instance belongs in Resource Management. If you do not set this parameter, the default resource group is used.	rg-acfm2pz25js****
PageNumber	integer	No	The page number of the current page in a paginated query. Default value: 1.	1
PageSize	integer	No	The number of domain names on each page in a paginated query. Default value: 10.	10

When you call this operation, in addition to the request parameters described in this topic, you must also include the Alibaba Cloud common request parameters. For more information about common request parameters, see Common parameters.

For the request format of this operation, see the request examples in this topic.

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of domain names queried.	1
RequestId	string	The ID of the request.	CF33B4C3-196E-4015-AADD-5CAD00057B80
SlsConfigStatus	array<object>	The full log switch status of the domain names.
	object
Domain	string	The domain name.	www.aliyundoc.com
Enable	boolean	Indicates whether full log collection is enabled. Valid values: true: enabled. false: disabled.	true

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "SlsConfigStatus": [
    {
      "Domain": "www.aliyundoc.com",
      "Enable": true
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.