全部產品
Search

搜尋本產品

    Web Application Firewall：CreateDomain

    文件中心

    Web Application Firewall：CreateDomain

    更新時間：Jul 06, 2026

    將網域接入 WAF 執行個體進行防護。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:CreateDomain

    create

    *DefenseResource

    acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

    您可以呼叫 DescribeInstance 查詢目前 WAF 執行個體的 ID。

    waf_cdnsdf3****
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q
    Domain

    string

    是

    要查詢的網域名稱。

    www.aliyundoc.com
    Listen

    object

    是

    設定監聽資訊。

    HttpsPorts

    array

    否

    HTTPS 通訊協定的監聽連接埠。

    integer

    否

    HTTPS 通訊協定的監聽連接埠，使用 [port1,port2,......,portN] 格式。

    [443,8443]
    HttpPorts

    array

    否

    HTTP 通訊協定的監聽連接埠。

    integer

    否

    HTTP 通訊協定的監聽連接埠，使用 [port1,port2,……] 格式。

    [80,81]
    Http2Enabled

    boolean

    否

    是否啟用 HTTP2。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • true：表示啟用 HTTP2。

    • false（預設）：表示不啟用 HTTP2。

    true
    CertId

    string

    否

    要新增的憑證 ID。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。

    123
    SM2Enabled

    boolean

    否

    是否啟用國密憑證。

    true
    SM2CertId

    string

    否

    要新增的國密憑證 ID。僅當 SM2Enabled 取值為 true 時，才使用此參數。

    123-cn-hangzhou
    SM2AccessOnly

    boolean

    否

    是否僅允許用戶端存取。僅當 SM2Enabled 取值為 true 時，才使用此參數。

    • true：僅國密用戶端才可以存取。

    • false：國密和非國密均可以存取。

    true
    TLSVersion

    string

    否

    要新增的 TLS 版本。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • tlsv1

    • tlsv1.1

    • tlsv1.2

    tlsv1
    EnableTLSv3

    boolean

    否

    是否支援 TLS1.3 版本。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • true：表示支援 TLS1.3 版本。

    • false：表示不支援 TLS1.3 版本。

    true
    CipherSuite

    integer

    否

    要新增的加密套件類型。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • 1：表示新增全部加密套件。

    • 2：表示新增強加密套件。僅當 TLSVersion 取值為 tlsv1.2 時，可選擇此取值。

    • 99：表示新增自訂加密套件。

    2
    CustomCiphers

    array

    否

    要新增的具體自訂加密套件。

    string

    否

    要新增的具體自訂加密套件。僅當 CipherSuite 設定為 99 時，才使用此參數。

    ["xxx","ffas"]
    FocusHttps

    boolean

    否

    是否啟用 HTTPS 強制重新導向。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定），且 HttpPorts 取值為空（表示網域未使用 HTTP 通訊協定）時，才使用此參數。取值：

    • true：表示啟用 HTTPS 強制重新導向。

    • false：表示不啟用 HTTPS 強制重新導向。

    true
    XffHeaderMode

    integer

    否

    WAF 取得用戶端真實 IP 的方式。取值：

    • 0（預設）：表示用戶端存取流量到達 WAF 前未經過其他七層代理轉送。

    • 1：表示 WAF 讀取要求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。

    • 2：表示 WAF 讀取要求標頭中由您設定的自訂欄位值作為用戶端 IP。

    1
    XffHeaders

    array

    否

    設定用於取得用戶端 IP 的自訂欄位清單。

    string

    否

    設定用於取得用戶端 IP 的自訂欄位清單，使用 ["header1","header2",……] 格式表示。

    說明

    僅在 XffHeaderMode 取值為 2（表示 WAF 讀取要求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定此參數。

    ["Client-ip","cip"]
    IPv6Enabled

    boolean

    否

    是否啟用 IPv6。取值：

    • true：表示啟用 IPv6。

    • false（預設）：表示不啟用 IPv6。

    true
    ProtectionResource

    string

    否

    要使用的防護資源類型。取值：

    • share（預設）：表示使用共用叢集。

    • gslb：表示使用共用叢集智慧負載平衡。

    share
    ExclusiveIp

    boolean

    否

    是否啟用獨享 IP。僅當 IPv6Enabled 取值為 false（表示不啟用 IPv6），且 ProtectionResource 取值為 share（表示使用共用叢集）時，才使用此參數。取值：

    • true：表示啟用獨享 IP。

    • false（預設）：表示不啟用獨享 IP。

    true
    HstsIncludeSubDomain

    boolean

    否

    HSTS 是否包含子網域。取值：

    • true：表示啟用。

    • false：表示不啟用。

    HstsPreload

    boolean

    否

    是否啟用 HSTS 預先載入，預設關閉。取值範圍：

    • true：啟用。

    • false：關閉。

    false
    HstsMaxAge

    integer

    否

    HSTS 過期時間，單位為秒。

    365000
    Redirect

    object

    是

    設定轉送資訊。

    Backends

    array

    否

    網域對應的來源伺服器 IP 或伺服器回源網域。

    string

    否

    網域對應的來源伺服器 IP 或伺服器回源網域。您只能選擇設定來源伺服器 IP 或伺服器回源網域中的一種，回源地址為網域時，僅支援 IPv4，暫不支援 IPv6：

    • 設定來源伺服器 IP 時，使用 ["ip1","ip2",……] 格式表示。最多支援新增 20 個 IP。

    • 設定伺服器回源網域時，使用 ["domain"] 格式表示。最多支援新增 20 個網域地址。

    [ "1.1.XX.XX", "2.2.XX.XX" ]
    Loadbalance

    string

    是

    回源時採用的負載平衡演算法。取值：

    • iphash：表示 IPHash 演算法。

    • roundRobin：表示輪詢演算法。

    • leastTime：表示 Least Time 演算法。僅當 ProtectionResource 取值為 gslb（表示防護資源類型使用共用叢集智慧負載平衡）時，可選擇此取值。

    roundRobin
    FocusHttpBackend

    boolean

    否

    是否啟用強制 HTTP 回源。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • true：表示啟用強制 HTTP 回源。

    • false：表示不啟用強制 HTTP 回源。

    true
    SniEnabled

    boolean

    否

    是否啟用回源 SNI。僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。取值：

    • true：表示啟用回源 SNI。

    • false（預設）：表示不啟用回源 SNI。

    true
    SniHost

    string

    否

    設定自訂 SNI 擴充欄位的值。如果不設定此參數，則預設使用要求標頭中 Host 欄位的值作為 SNI 擴充欄位的值。 一般情況無需自訂 SNI，除非您的業務有特殊設定需求，希望 WAF 在回源要求中使用與實際要求 Host 不一致的 SNI（即此處設定的自訂 SNI）。

    說明

    僅在 SniEnabled 取值為 true（表示啟用回源 SNI）時，需要設定此參數。

    www.aliyundoc.com
    RequestHeaders

    array<object>

    否

    網域的流量標記欄位和值，用於標記經過 WAF 處理的流量。

    透過指定自訂要求標頭欄位和對應的值，當網域的存取流量經過 WAF 時，WAF 會自動在要求標頭中新增所設定的自訂欄位值作為流量標記，便於後端服務統計相關資訊。

    object

    否

    此參數值的格式為 [{"k":"key","v":"value"}]。其中，key 表示所指定的自訂要求標頭欄位，value 表示為該欄位設定的值。

    Key

    string

    否

    指定的自訂要求標頭欄位。

    aaa
    Value

    string

    否

    自訂要求標頭欄位設定的值。

    bbb
    ConnectTimeout

    integer

    否

    連線逾時時長。單位：秒。 取值範圍：1~3600。 預設值：5。

    120
    ReadTimeout

    integer

    否

    讀取逾時時長，單位：秒。 取值範圍：1~3600。 預設值：120。

    200
    WriteTimeout

    integer

    否

    寫入逾時時長，單位：秒。 取值範圍：1~3600。 預設值：120。

    200
    CnameEnabled

    boolean

    否

    是否啟用公用雲端容災。取值：

    • true：表示啟用公用雲端容災。

    • false（預設）：表示不啟用公用雲端容災。

    true
    RoutingRules

    string

    否

    混合雲端轉送規則。使用 JSON 陣列轉換的字串格式表示。JSON 陣列中的每個元素是一個結構體，包含以下欄位：

    • rs：Array 類型 | 表示回源 IP 地址或回源 CNAME 清單

    • backupRs：Array 類型 | 表示回源備用 IP 地址或回源 CNAME 清單，必填，[] 表示不設定

    • location：String 類型 | 表示防護節點名稱

    • locationId：Long 類型 | 表示防護節點 ID

    [ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
    Keepalive

    boolean

    否

    是否保持長連線。取值：

    • true（預設）：表示保持長連線。

    • false：表示不保持長連線。

    true
    Retry

    boolean

    否

    WAF 回源失敗時，是否重試。取值：

    • true（預設）：表示重試。

    • false：表示不重試。

    true
    KeepaliveRequests

    integer

    否

    複用長連線的要求個數。取值範圍：60~1000，預設值：1000，單位：個。

    說明

    啟用長連線後，複用多少個長連線。

    1000
    KeepaliveTimeout

    integer

    否

    閒置長連線逾時時間，取值範圍：1~60，預設 15，單位：秒。

    說明

    複用的長連線閒置多久後釋放。

    15
    XffProto

    boolean

    否

    X-Forward-For-Proto 傳遞 WAF 的通訊協定。取值：

    • true（預設）：表示傳遞 WAF 的通訊協定。

    • false：表示不傳遞 WAF 的通訊協定。

    false
    BackupBackends

    array

    否

    網域對應的備用來源伺服器 IP 或伺服器回源網域。

    string

    否

    網域對應的備用來源伺服器 IP 或伺服器回源網域。您只能選擇設定來源伺服器 IP 或伺服器回源網域中的一種，回源地址為網域時，僅支援 IPv4，暫不支援 IPv6：

    • 設定來源伺服器 IP 時，使用 ["ip1","ip2",……] 格式表示。最多支援新增 20 個 IP。

    • 設定伺服器回源網域時，使用 ["domain"] 格式表示。最多支援新增 20 個網域地址。

    [ "1.1.XX.XX", "2.2.XX.XX" ]
    XClientIp

    boolean

    否

    是否允許 WAF 覆蓋 X-Client-IP。取值：

    • true（預設）：表示允許 WAF 覆蓋。

    • false：表示不允許 WAF 覆蓋。

    true
    XTrueIp

    boolean

    否

    是否允許 WAF 覆蓋 X-True-IP。取值：

    • true（預設）：表示允許 WAF 覆蓋。

    • false：表示不允許 WAF 覆蓋。

    true
    WebServerType

    boolean

    否

    是否允許 WAF 覆蓋 Web-Server-Type。取值：

    • true（預設）：表示允許 WAF 覆蓋。

    • false：表示不允許 WAF 覆蓋。

    true
    WLProxyClientIp

    boolean

    否

    是否允許 WAF 覆蓋 WL-Proxy-Client-IP。取值：

    • true（預設）：表示允許 WAF 覆蓋。

    • false：表示不允許 WAF 覆蓋。

    true
    MaxBodySize

    integer

    否

    最大要求主體大小。取值範圍：2~10，預設值：2，單位：G。

    說明

    僅旗艦版支援。

    2
    Http2Origin

    boolean

    否

    HTTP2 回源。取值：

    • true：表示啟用 HTTP2 回源。

    • false：表示不啟用 HTTP2 回源。

    true
    Http2OriginMaxConcurrency

    integer

    否

    HTTP2 回源最大並行數。取值範圍：1-512，預設值：128，單位：個。

    128
    BackendPorts

    array<object>

    否

    自訂連接埠設定。

    object

    否

    自訂連接埠設定。

    ListenPort

    integer

    否

    監聽連接埠。

    80
    BackendPort

    integer

    否

    回源連接埠。

    80
    Protocol

    string

    否

    監聽連接埠的通訊協定。取值：

    • http：表示監聽連接埠的通訊協定為 HTTP。

    • https：表示監聽連接埠的通訊協定為 HTTPS。

    http
    ProxyProtocol

    boolean

    否

    是否啟用了保持用戶端來源 IP 功能。

    • true：啟用了保持用戶端來源 IP 功能。啟用後，支援後端服務檢視用戶端的原始 IP 地址。

    • false：未啟用保持用戶端來源 IP 功能。

    false
    RegionId

    string

    是

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

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

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

    cn-hangzhou
    AccessType

    string

    否

    WAF 執行個體的接入類型。取值：

    • share（預設）：表示 CNAME 接入。

    • hybrid_cloud_cname：表示混合雲端 CNAME 接入。

    share
    Tag

    array<object>

    否

    標籤清單，最多包含 20 個子項目。

    object

    否

    資源的標籤，最多支援 20 個子項目。

    Key

    string

    否

    標籤鍵。

    Tagkey1
    Value

    string

    否

    標籤值。

    TagValue1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    新增網域後的返回結果。

    RequestId

    string

    要求 ID。

    D7861F61-5B61-46CE-A47C-6B19160D5EB0
    DomainInfo

    object

    已新增的網域資訊。

    Cname

    string

    WAF 為網域分配的 CNAME 地址。

    xxxxxwww.****.com
    Domain

    string

    已新增的網域名稱。

    www.aliyundoc.com
    DomainId

    string

    網域 ID。

    www.aliyundoc.com-waf

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainInfo": {
    "Cname": "xxxxxwww.****.com",
    "Domain": "www.aliyundoc.com",
    "DomainId": "www.aliyundoc.com-waf"
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Waf.Pullin.ResourceExsit Access resource already exists, resource:%s. 接入資源已存在，已存在的資源：%s。
    400 Waf.Pullin.BusinessViolation The web services are suspected of violating regulations. If you have any questions, please submit a work order. Violating resource: %s. 業務涉嫌違規，如有疑問請走工單流程。違規資源：%s。
    400 Waf.Pullin.Http2OriginMustOnHttp2Enable When HTTP2 origin is enabled, HTTP2 listening must be enabled. 開啟 HTTP2 回源時，HTTP2 監聽必須開啟。
    400 Waf.Pullin.Http2OriginMustOnKeepaliveEnable When the HTTP2 origin is turned on, the keepalive must be turned on. 開啟 HTTP2 回源時，長連線必須開啟。
    400 Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden When HTTP2 origin is enabled, HTTP origin cannot be enabled. 開啟 HTTP2 回源時，不能開啟 HTTP 回源。
    400 Waf.Pullin.BatchDnsScheduleCheckFailed Batch dns scheduling is in progress, and access related operations are prohibited. 批次 DNS 調度進行中，禁止接入相關操作。
    400 Waf.Pullin.InvalidMaxAgeWithPreload HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000. HstsMaxAge 參數有誤，HstsPreload 為 True 時，HstsMaxAge 必須大於等於 31536000。
    400 Waf.Pullin.InvalidIncludeSubDomainWithPreload The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true. 參數HstsIncludeSubDomain無效，參數HstsPreload為true時，HstsIncludeSubDomain必須為true。
    400 Waf.Pullin.InvalidCustomCiphers Invalid custom cipher suite. 無效自訂加密套件。
    400 Waf.Pullin.InvalidHttp2OriginWithProxyProtocol http2Origin and proxyProtocol cannot be opened at the same time. http2Origin 和 proxyProtocol 不能同時開啟。

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

    變更歷史

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