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

list

*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-cn-zz11sr5****
DeliveryNameLike	string	No	The name of the log delivery configuration that you want to query. Fuzzy match is supported.	test
DeliveryType	string	No	The type of the log delivery configuration that you want to query. Valid values: syslog: Log delivery to a syslog server. kafka: Log delivery to a Kafka cluster.	kafka
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 to which the WAF instance belongs.	rg-acfm***q
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Set this parameter to the value of NextToken returned in the previous call. You do not need to specify this parameter for the first request.	AAAAAINZ+8pH1oQnusEu1tGAc8is
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 50. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2EFCFE18-78F8-5079-B312-07***48B
DeliveryConfigs	array<object>	The log delivery configurations.
	object	The details of a log delivery configuration.
DeliveryName	string	The name of the log delivery configuration.	test1
DeliveryDetail	string	The details of the log delivery configuration, returned as a JSON string. Note The structure of this parameter is the same as the DeliveryDetail request parameter of the CreateLogDeliveryConfig operation.	详见各个外发投递类型的内容详情
DeliveryType	string	The type of the log delivery configuration. Valid values: syslog: Log delivery to a syslog server. kafka: Log delivery to a Kafka cluster.	kafka
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Note If this parameter is not empty, more results are available. Use the value of NextToken in the next request to retrieve the next page of results. If the value is empty, all results have been returned.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The maximum number of entries returned per page.	20
TotalCount	integer	The total number of log delivery configurations returned.	5

Examples

Success response

JSON format

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "DeliveryConfigs": [
    {
      "DeliveryName": "test1",
      "DeliveryDetail": "详见各个外发投递类型的内容详情",
      "DeliveryType": "kafka"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20,
  "TotalCount": 5
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.