DescribeCommonLogFields - Web Application Firewall - Alibaba Cloud Documentation Center

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

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_v3prepaid_public_cn-l*****
IsRequired	boolean	No	Specifies whether to query for required log fields. true: Queries for required log fields. false: Queries for non-required log fields.	false
IsDefault	boolean	No	Specifies whether to query for default log fields. true: Queries for default log fields. false: Queries for non-default log fields.	true
LogKeyList	array	No	The list of log fields to query.
	string	No	The log field to query.	final_action
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aek2sxgs*****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of log fields.	6
RequestId	string	The ID of the request.	AB0775EB-2594-598A-97E1-51B1*******
LogFieldList	array<object>	The list of log fields.
	object	The details of the log field.
Status	boolean	The status of the log field. Valid values: 0: offline. 1: online or in use. 2: about to be unpublished. 3: about to be published.	1
IsDefault	boolean	Indicates whether the log field is a default field. true: The log field is a default field. false: The log field is not a default field.	true
IsRequired	boolean	Indicates whether the log field is required. true: The log field is required. false: The log field is not required.	true
LogKey	string	The log field. Note For more information about the log fields, see Log field descriptions.	final_action

Examples

Success response

JSON format

{
  "TotalCount": 6,
  "RequestId": "AB0775EB-2594-598A-97E1-51B1*******",
  "LogFieldList": [
    {
      "Status": true,
      "IsDefault": true,
      "IsRequired": true,
      "LogKey": "final_action"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.