全部產品
Search

搜尋本產品

    Web Application Firewall：CreateLogDeliveryConfig - 建立混合雲日誌外發投遞配置

    文件中心

    Web Application Firewall：CreateLogDeliveryConfig - 建立混合雲日誌外發投遞配置

    更新時間：Apr 21, 2026

    建立混合雲日誌外發投遞配置。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:CreateLogDeliveryConfig

    create

    *全部資源

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

    您可以調用 DescribeInstance 查詢當前 WAF 執行個體的 ID。

    waf_elasticity-cn-0xldbqt****
    DeliveryName

    string

    是

    外發投遞配置名稱。

    test1
    DeliveryType

    string

    是

    外發投遞配置類型。取值為：

    • syslog：表示外發到 syslog 服務。

    • kafka：表示外發到 kafka 服務。

    syslog
    DeliveryDetail

    string

    是

    外發投遞配置內容，以一系列參數構造的 JSON 格式轉化成字串。

    說明

    根據所指定的外發投遞配置類型（DeliveryType）不同，具體涉及的參數有所不同。詳細資料，請參見外發投遞配置內容參數描述。

    { "rfcVersion": "rfc3164", "protocol": "tcp", "servers": [ { "address": "1.1.1.1", "port": 20 } ] }
    RegionId

    string

    否

    WAF 執行個體所屬地區。取值：

    • cn-hangzhou：表示中國內地。

    • ap-southeast-1：表示非中國內地。

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q

    外發投遞配置內容參數描述

    外發 syslog Log Service（syslog）

    參數描述

    名稱類型是否必選樣本值描述
    serversArray必選[{"address":"11.11.XX.XX","port":8000}]syslog 服務遠端地址配置，當外發配置類型為 syslog 時只支援一個地址。其中：
    - address：表示伺服器網域名稱或者 IP，其中 IP 支援 IPv4 或 IPv6，必選。
    - port：表示伺服器連接埠，必選。

    rfcVersionString可選rfc3164syslog 的 RFC 版本。取值：
    - rfc3164（預設）：表示 RFC3164 版本。
    - rfc5424：表示 RFC5424 版本。

    protocolString必選tcpsyslog 的協議類型。取值：
    - 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 Log Service（kafka）

    參數描述

    名稱類型是否必選樣本值描述
    serversArray必選[{"address":"a.com","port":8000}]kafka 服務遠端地址配置，當外發配置類型為 kafka 時最多支援 3 個地址。其中：
    - address：表示伺服器網域名稱或者 IP，其中 IP 支援 IPv4 或 IPv6，必選。
    - port：表示伺服器連接埠，必選。

    kafkaTopicString必選testkafka 的 Topic ID 或名稱。
    protocolString必選PLAINTEXTkafka 的安全性通訊協定。取值：
    - PLAINTEXT（預設）：表示 PLAINTEXT 協議。
    - SASL_PLAINTEXT：表示 SASL_PLAINTEXT 協議。
    - SASL_SSL：表示 SASL_SSL 協議。


    saslUserNameString可選user123kafka 的 SASL 認證的使用者名稱。當 kafka 的安全性通訊協定（protocol）取值為SASL_PLAINTEXT或SASL_SSL時必選。
    saslPasswordString可選user***kafka 的 SASL 認證的密碼。當 kafka 的安全性通訊協定（protocol）取值為SASL_PLAINTEXT或SASL_SSL時必選。
    pemCertString可選Certkafka 的自訂認證，支援 pem 格式。
    compressionCodecString可選nonekafka 的壓縮類型。取值：
    - 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****"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。