全部產品
Search

搜尋本產品

    ：DescribeDomain

    文件中心

    ：DescribeDomain

    更新時間：Jul 01, 2024

    調用DescribeDomain查詢已添加到WAF防護的網域名稱的配置資訊。

    調試

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

    請求參數

    名稱

    類型

    是否必選

    樣本值

    描述

    Action

    String

    是

    DescribeDomain

    要執行的動作。取值：DescribeDomain。

    Domain

    String

    是

    www.example.com

    要查詢的網域名稱名稱。

    說明

    您可以調用DescribeDomainNames查詢所有已添加到WAF防護的網域名稱。

    InstanceId

    String

    是

    waf-cn-7pp26f1****

    WAF執行個體的ID。

    說明

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

    調用API時，除了本文中該API的請求參數，還需加入阿里雲API公用請求參數。公用請求參數的詳細介紹，請參見公用參數。

    調用API的請求格式，請參見本文樣本中的請求樣本。

    返回資料

    名稱

    類型

    樣本值

    描述

    RequestId

    String

    D827FCFE-90A7-4330-9326-D33C8B4C7726

    本次請求的ID。

    Domain

    Struct

    網域名稱的配置資訊。

    AccessHeaderMode

    Integer

    1

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

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

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

    說明

    僅當IsAccessProduct取值為1（表示WAF前有其他七層代理服務）時，返回該參數。

    AccessHeaders

    List

    ["X-Client-IP"]

    用於擷取用戶端IP的自訂欄位列表。

    說明

    僅當AccessHeaderMode取值為1（表示WAF讀取要求標頭中由您設定的自訂欄位值作為用戶端IP）時，返回該參數。

    AccessType

    String

    waf-cloud-dns

    網域名稱接入方式。取值：

    • waf-cloud-dns：表示CNAME接入。

    • waf-cloud-native：表示透明接入。

    CloudNativeInstances

    Array of CloudNativeInstances

    透明接入的配置列表。

    說明

    僅當AccessType取值為waf-cloud-native（表示網域名稱使用透明接入方式接入WAF）時，返回該參數。

    CloudNativeProductName

    String

    ALB

    雲產品執行個體的類型。取值：

    • SLB：表示傳統型負載平衡CLB（原SLB）執行個體。

    • ECS：表示Elastic Compute Service執行個體。

    • ALB：表示應用型負載平衡ALB執行個體。

    IPAddressList

    String

    ["39.XX.XX.197"]

    雲產品執行個體的公網IP地址清單。

    InstanceId

    String

    alb-s65nua68wdedsp****

    雲產品執行個體的ID。

    ProtocolPortConfigs

    Array of ProtocolPortConfigs

    協議及連接埠配置列表。

    Ports

    String

    [80]

    連接埠列表。

    Protocol

    String

    http

    協議類型。取值：

    • http：表示HTTP協議。

    • https：表示HTTPS協議。

    RedirectionTypeName

    String

    ALB

    引流連接埠的類型。取值：

    • SLB-L4：表示從傳統型負載平衡CLB（原SLB）執行個體的四層監聽連接埠引流到WAF進行防護。

    • SLB-L7：表示從傳統型負載平衡CLB（原SLB）執行個體的七層監聽連接埠引流到WAF進行防護。

    • ECS：表示從Elastic Compute Service執行個體的監聽連接埠引流到WAF進行防護。

    • ALB：表示從應用型負載平衡ALB執行個體的HTTP、HTTPS監聽連接埠引流到WAF進行防護。

    ClusterType

    Integer

    0

    WAF執行個體對應的叢集類型。取值：

    • 0：表示物理叢集。

    • 1：表示虛擬叢集，即WAF獨享叢集。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    Cname

    String

    kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

    WAF為網域名稱分配的CNAME地址。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    ConnectionTime

    Integer

    5

    WAF叢集的連線逾時時間長度。單位：秒。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    Http2Port

    List

    [443,8443]

    HTTP 2.0連接埠列表。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）且HttpsPort取值不為空白（表示網域名稱使用HTTPS協議）時，返回該參數。

    HttpPort

    List

    [80]

    HTTP連接埠列表。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    HttpToUserIp

    Integer

    0

    是否開啟了HTTP回源功能。取值：

    • 0：表示未開啟。

    • 1：表示已開啟。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）且HttpsPort取值不為空白（表示網域名稱使用HTTPS協議）時，返回該參數。

    HttpsPort

    List

    [443,8443]

    HTTPS連接埠列表。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    HttpsRedirect

    Integer

    0

    是否開啟了HTTPS強制跳轉。取值：

    • 0：表示未開啟。

    • 1：表示已開啟。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）且HttpsPort取值不為空白（表示網域名稱使用HTTPS協議）時，返回該參數。

    IpFollowStatus

    Integer

    1

    是否開啟了IPv4/IPv6回源協議跟隨。取值：

    • 0：表示未開啟。

    • 1：表示已開啟。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    IsAccessProduct

    Integer

    1

    網域名稱在WAF前是否配置有其他七層代理（例如高防、CDN等），即用戶端訪問流量到WAF前是否有經過其他七層代理轉寄。取值：

    • 0：表示否。

    • 1：表示是。

    LoadBalancing

    Integer

    2

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

    • 0：表示IP Hash演算法。

    • 1：表示輪詢演算法。

    • 2：表示Least Time演算法。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    LogHeaders

    Array of LogHeader

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

    說明

    僅當網域名稱開啟了流量標記功能時，返回該參數。

    k

    String

    ALIWAF-TAG

    流量標記欄位的名稱。

    v

    String

    Yes

    流量標記欄位的值。

    ReadTime

    Integer

    120

    WAF叢集的讀連線逾時時間長度。單位：秒。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    ResourceGroupId

    String

    rg-acfm2mkrunv****

    WAF執行個體所屬資源群組ID。

    SniHost

    String

    waf.example.com

    SNI擴充欄位的自訂值。取值為空白表示未自訂SNI值，預設使用要求標頭中Host欄位的值作為SNI擴充欄位的值。

    說明

    僅在SniStatus取值為1（表示開啟SNI回源）時，返回該參數。

    SniStatus

    Integer

    1

    是否開啟了回源SNI。回源SNI表示WAF轉寄用戶端請求到來源站點伺服器，在與來源站點進行TLS握手時，通過SNI擴充欄位（Server Name Indicator extension）指定要訪問的主機，並與該主機建立HTTPS串連。取值：

    • 0：表示未開啟。

    • 1：表示已開啟。

    說明

    僅在AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式）且HttpsPort取值不為空白（表示網域名稱使用HTTPS協議）時，返回該參數。

    SourceIps

    List

    ["39.XX.XX.197"]

    來源站點伺服器位址。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    Version

    Long

    40

    當前網域名稱配置的版本。

    WriteTime

    Integer

    120

    WAF叢集的寫連線逾時時間長度。單位：秒。

    說明

    僅當AccessType取值為waf-cloud-dns（表示網域名稱使用CNAME接入方式接入WAF）時，返回該參數。

    Retry

    Boolean

    true

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

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

    • false：表示不重試。

    Keepalive

    Boolean

    true

    是否保持長串連。取值：

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

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

    KeepaliveRequests

    Integer

    1000

    複用長串連的請求個數。取值範圍：60~1000，單位：個。

    說明

    開啟長串連後，複用多少個長串連。

    KeepaliveTimeout

    Integer

    15

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

    說明

    複用的長串連空閑多長時間後釋放。

    樣本

    請求樣本

    http(s)://[Endpoint]/?Action=DescribeDomain
&Domain=www.example.com
&InstanceId=waf-cn-7pp26f1****
&<公用請求參數>

    正常返回樣本

    XML格式

    <DescribeDomainResponse>
	  <RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>
	  <Domain>
		    <HttpToUserIp>0</HttpToUserIp>
		    <HttpPort>80</HttpPort>
		    <IsAccessProduct>1</IsAccessProduct>
		    <AccessHeaderMode>1</AccessHeaderMode>
		    <ResourceGroupId>rg-acfm2mkrunv****</ResourceGroupId>
		    <AccessHeaders>X-Client-IP</AccessHeaders>
		    <ReadTime>120</ReadTime>
		    <SourceIps>39.XX.XX.197</SourceIps>
		    <IpFollowStatus>1</IpFollowStatus>
		    <ClusterType>0</ClusterType>
		    <LoadBalancing>2</LoadBalancing>
		    <Cname>kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com</Cname>
		    <LogHeaders>
			      <v>Yes</v>
			      <k>ALIWAF-TAG</k>
		    </LogHeaders>
		    <WriteTime>120</WriteTime>
		    <Http2Port>443</Http2Port>
		    <Http2Port>8443</Http2Port>
		    <Version>40</Version>
		    <HttpsRedirect>0</HttpsRedirect>
		    <ConnectionTime>5</ConnectionTime>
		    <AccessType>waf-cloud-dns</AccessType>
		    <HttpsPort>443</HttpsPort>
		    <HttpsPort>8443</HttpsPort>
        <Keepalive>true</Keepalive>
        <KeepaliveTimeout>15</KeepaliveTimeout>
        <Retry>true</Retry>
        <KeepaliveRequests>1000</KeepaliveRequests>
	  </Domain>
</DescribeDomainResponse>

    JSON格式

    {
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C7726",
  "Domain": {
    "HttpToUserIp": 0,
    "HttpPort": [
      80
    ],
    "IsAccessProduct": 1,
    "AccessHeaderMode": 1,
    "ResourceGroupId": "rg-acfm2mkrunv****",
    "AccessHeaders": [
      "X-Client-IP"
    ],
    "ReadTime": 120,
    "SourceIps": [
      "39.XX.XX.197"
    ],
    "IpFollowStatus": 1,
    "ClusterType": 0,
    "LoadBalancing": 2,
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com",
    "LogHeaders": [
      {
        "v": "Yes",
        "k": "ALIWAF-TAG"
      }
    ],
    "WriteTime": 120,
    "Http2Port": [
      443,
      8443
    ],
    "Version": 40,
    "HttpsRedirect": 0,
    "ConnectionTime": 5,
    "AccessType": "waf-cloud-dns",
    "HttpsPort": [
      443,
      8443
    ],
    "Keepalive": true,
    "KeepaliveTimeout": 15,
    "SniStatus": 0,
    "Retry": true,
    "KeepaliveRequests": 1000
  }
}

    錯誤碼

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