CreateLogDeliveryConfig - 创建混合云日志外发投递配置-Web应用防火墙(WAF)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_elasticity-cn-0xldbqt****
DeliveryName	string	是	外发投递配置名称。	test1
DeliveryType	string	是	外发投递配置类型。取值为： syslog：表示外发到 syslog 服务。 kafka：表示外发到 kafka 服务。	kafka
DeliveryDetail	string	是	外发投递配置内容，以一系列参数构造的 JSON 格式转化成字符串。说明根据所指定的外发投递配置类型（DeliveryType）不同，具体涉及的参数有所不同。详细信息，请参见外发投递配置内容参数描述。	详见各个外发投递类型的内容详情
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

外发投递配置内容参数描述

外发 syslog 日志服务（syslog）

参数描述

名称	类型	是否必选	示例值	描述
servers	Array	必选	[{"address":"11.11.XX.XX","port":8000}]	syslog 服务远端地址配置，当外发配置类型为 syslog 时只支持一个地址。其中： - address：表示服务器域名或者 IP，其中 IP 支持 IPv4 或 IPv6，必选。 - port：表示服务器端口，必选。
rfcVersion	String	可选	rfc3164	syslog 的 RFC 版本。取值： - rfc3164（默认）：表示 RFC3164 版本。 - rfc5424：表示 RFC5424 版本。
protocol	String	必选	tcp	syslog 的协议类型。取值： - tcp：表示 TCP 连接。 - udp：表示 UDP 连接。

示例

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

外发 kafka 日志服务（kafka）

参数描述

名称	类型	是否必选	示例值	描述
servers	Array	必选	[{"address":"a.com","port":8000}]	kafka 服务远端地址配置，当外发配置类型为 kafka 时最多支持 3 个地址。其中： - address：表示服务器域名或者 IP，其中 IP 支持 IPv4 或 IPv6，必选。 - port：表示服务器端口，必选。
kafkaTopic	String	必选	test	kafka 的 Topic ID 或名称。
protocol	String	必选	PLAINTEXT	kafka 的安全协议。取值： - PLAINTEXT（默认）：表示 PLAINTEXT 协议。 - SASL_PLAINTEXT：表示 SASL_PLAINTEXT 协议。 - SASL_SSL：表示 SASL_SSL 协议。
saslUserName	String	可选	user123	kafka 的 SASL 认证的用户名。当 kafka 的安全协议（protocol）取值为SASL_PLAINTEXT或SASL_SSL时必选。
saslPassword	String	可选	user***	kafka 的 SASL 认证的密码。当 kafka 的安全协议（protocol）取值为SASL_PLAINTEXT或SASL_SSL时必选。
pemCert	String	可选	Cert	kafka 的自定义证书，支持 pem 格式。
compressionCodec	String	可选	none	kafka 的压缩类型。取值： - none（默认）：表示不压缩。 - gzip：表示 gzip 压缩。 - zstd：表示 zstd 压缩。 - lz4：表示 lz4 压缩。 - snappy：表示 snappy 压缩。

示例

{
	"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****\"}"
}

返回参数

名称	类型	描述	示例值
	object
DeliveryName	string	外发投递配置名称。	test1
RequestId	string	本次请求的 ID。	26E46541-7AAB-5565-801D-F14DBDC5****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。