DescribeResourceLogFieldConfig - Web Application Firewall

Queries the log field configuration for a protected object.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of the WAF instance.	waf_v3prepaid_public_cn-zpr3*******
DeliveryType	string	Yes	The log delivery type. Valid values: sls: Alibaba Cloud Simple Log Service. kafka: Delivers logs to Kafka. syslog: Delivers logs to Syslog.	sls
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
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
Resource	string	Yes	The protected object to query.	test.waf.com-waf

Response elements

Element	Type	Description	Example
	object
AddList	string	The extra log fields that are configured in addition to the default log fields. The fields are specified as a string of comma-separated values.	acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type
RequestId	string	The request ID.	7B53B47C-D368-5344-BB5E-79******
LogDeliveryStrategy	string	The log delivery policies. Multiple policies are supported. The value is a string that is converted from a JSON array of parameters. Note For more information about the parameters, see the description of the LogDeliveryStrategy parameter in ModifyResourceLogFieldConfig.	[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]
ExtendConfig	string	The extended configuration for log delivery. The value is a string that is converted from a JSON object of parameters. Note For more information about the parameters, see the description of the ExtendConfig parameter in ModifyResourceLogFieldConfig.	{\"request_header\":\"Ali-Cdn-Real-Ip\"}
DelList	string	The log fields that are removed from the default log fields. The fields are specified as a string of comma-separated values.	waf_rule_id,waf_rule_type
FieldList	string	The list of delivered log fields. The fields are specified as a string of comma-separated values.	account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids
DeliveryType	string	The log delivery type. Valid values: sls: Alibaba Cloud Simple Log Service. kafka: Delivers logs to Kafka. syslog: Delivers logs to Syslog.	sls

Examples

Success response

JSON format

{
  "AddList": "acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type",
  "RequestId": "7B53B47C-D368-5344-BB5E-79******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids",
  "DeliveryType": "sls"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.