WAF Log Collection Status for Protected Objects - Web Application Firewall - Alibaba Cloud - Web Application Firewall

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-waf:DescribeResourceLogStatus

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf-cn-zz11zcl****
Resources	string	Yes	The protected objects to query. Separate multiple protected objects with commas (,).	alb-wewbb23dfsetetcic1242-0**,alb-wewbb23dfsetetcic1242-1**
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The Alibaba Cloud resource group ID.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The request result.
RequestId	string	The request ID.	0DABF8AB-2321-5F8D-A8D7-922D757FBFFE
Result	array<object>	The returned result.
	array<object>	The log status information of the protected object.
Status	boolean	The log enabling status of the protected object. Valid values: true: Logging is enabled. false: Logging is disabled.	true
Resource	string	The queried protected object.	alb-wewbb23dfsetetcic****
TraceStatus	boolean	The Tracing Analysis status. Valid values: true: Tracing Analysis is enabled. false: Tracing Analysis is shutdown.	true
TraceConfig	object	The Tracing Analysis configuration.
Workspace	string		cms-test
RatePerMille	integer		90

Examples

Success response

JSON format

{
  "RequestId": "0DABF8AB-2321-5F8D-A8D7-922D757FBFFE",
  "Result": [
    {
      "Status": true,
      "Resource": "alb-wewbb23dfsetetcic****",
      "TraceStatus": true,
      "TraceConfig": {
        "Workspace": "cms-test",
        "RatePerMille": 90
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.