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

create

*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 WAF instance.	waf_elasticity-cn-0xldbqt****
DeliveryName	string	Yes	The name of the log delivery configuration.	test1
DeliveryType	string	Yes	The type of the log delivery configuration. Valid values: syslog: Delivers logs to a syslog service. kafka: Delivers logs to a Kafka service.	kafka
DeliveryDetail	string	Yes	The details of the log delivery configuration. The value is a JSON string that is generated from a series of parameters. Note The parameters vary based on the value of DeliveryType. For more information, see Parameters for log delivery configuration details.	详见各个外发投递类型的内容详情
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-acfm***q

Log delivery configuration details

Deliver logs to a syslog service (syslog)

Parameters

Name	Type	Required	Example	Description
servers	Array	Yes	[{"address":"11.11.XX.XX","port":8000}]	The remote address of the syslog service. If DeliveryType is set to syslog, you can specify only one address. The address includes the following parameters: - address: The domain name or IP address of the server. IPv4 and IPv6 addresses are supported. This parameter is required. - port: The server port. This parameter is required.
rfcVersion	String	No	rfc3164	The RFC version for syslog. Valid values: - rfc3164 (default): RFC 3164. - rfc5424: RFC 5424.
protocol	String	Yes	tcp	The protocol for syslog. Valid values: - tcp: TCP. - udp: UDP.

Example

{
	"InstanceId": "waf_v2_public_cn-n*******",
	"DeliveryName": "test1",
	"DeliveryType": "syslog",
	"DeliveryDetail": "{\"rfcVersion\":\"rfc3164\",\"protocol\":\"tcp\",\"servers\":[{\"address\":\"11.11.XX.XX\",\"port\":8000}]}"
}

Deliver logs to a Kafka service (kafka)

Parameters

Name	Type	Required	Example	Description
servers	Array	Yes	[{"address":"a.com","port":8000}]	The remote address of the Kafka service. If DeliveryType is set to kafka, you can specify up to three addresses. Each address includes the following parameters: - address: The domain name or IP address of the server. IPv4 and IPv6 addresses are supported. This parameter is required. - port: The server port. This parameter is required.
kafkaTopic	String	Yes	test	The topic ID or name for Kafka.
protocol	String	Yes	PLAINTEXT	The security protocol for Kafka. Valid values: - PLAINTEXT (default): PLAINTEXT. - SASL_PLAINTEXT: SASL_PLAINTEXT. - SASL_SSL: SASL_SSL.
saslUserName	String	No	user123	The username for SASL authentication of the Kafka service. This parameter is required if protocol is set to SASL_PLAINTEXT or SASL_SSL.
saslPassword	String	No	user***	The password for SASL authentication of the Kafka service. This parameter is required if protocol is set to SASL_PLAINTEXT or SASL_SSL.
pemCert	String	No	Cert	The custom certificate for the Kafka service. The certificate must be in the PEM format.
compressionCodec	String	No	none	The compression type for Kafka. Valid values: - none (default): no compression. - gzip: Gzip. - zstd: Zstandard. - lz4: LZ4. - snappy: Snappy.

Example

{
	"InstanceId": "waf_v2_public_cn-n*********",
	"DeliveryName": "test2",
	"DeliveryType": "kafka",
	"DeliveryDetail": "{\"kafkaTopic\":\"topictest1\",\"protocol\":\"SASL_PLAINTEXT\",\"servers\":[{\"address\":\"a.com\",\"port\":1000},{\"address\":\"ba.com\",\"port\":1000},{\"address\":\"c.com\",\"port\":1000}],\"saslUserName\":\"user123\",\"saslPassword\":\"user****\"}"
}

Response elements

Element	Type	Description	Example
	object
DeliveryName	string	The name of the log delivery configuration.	test1
RequestId	string	The ID of the request.	26E46541-7AAB-5565-801D-F14DBDC5****

Examples

Success response

JSON format

{
  "DeliveryName": "test1",
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.