Web Application Firewall (WAF) に追加されたドメイン名の設定を照会します。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | DescribeDomain | 実行する操作。値を DescribeDomain に設定します。 |
| Domain | String | はい | www.example.com | DescribeDomainNames照会するドメイン名。WAF に追加されたドメイン名を取得するには、 操作を呼び出します。 |
| InstanceId | String | はい | waf-cn-7pp26f1**** | WAF インスタンスの ID です。インスタンス ID を取得するには、DescribeInstanceInfo 操作を呼び出します。 |
すべての Alibaba Cloud API リクエストには、共通リクエストパラメーターを含める必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンス要素
| パラメーター | タイプ | 例 | 説明 |
|---|---|---|---|
| RequestId | String | D827FCFE-90A7-4330-9326-D33C8B4C7726 | リクエスト ID。 |
| Domain | Struct | ドメイン名の設定。 |
Domain
| パラメーター | タイプ | 例 | 説明 |
|---|---|---|---|
| AccessHeaderMode | Integer | 1 | 実際のクライアント IP アドレスを取得するために使用されるメソッド。有効な値:0: WAF は X-Forwarded-For (XFF) ヘッダーの最初の値を読み取ります。1: WAF はカスタムヘッダーフィールドの値を読み取ります。IsAccessProduct が 1 の場合にのみ返されます。 |
| AccessHeaders | List | ["X-Client-IP"] | 実際のクライアント IP アドレスを取得するために使用されるカスタムヘッダーフィールド。AccessHeaderMode が 1 の場合にのみ返されます。 |
| AccessType | String | waf-cloud-dns | ドメイン名を WAF に追加するために使用されるモード。有効な値:waf-cloud-dns: CNAME レコードモード。waf-cloud-native: 透過型プロキシモード。 |
| ClusterType | Integer | 0 | WAF 保護クラスターのタイプ。有効な値:0: 共有クラスター。1: 専用クラスター。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| Cname | String | kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com | WAF によってドメイン名に割り当てられた CNAME。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| ConnectionTime | Integer | 5 | WAF クラスターの接続タイムアウト期間。単位:秒。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| Http2Port | List | [443,8443] | HTTP/2 ポート。AccessType が waf-cloud-dns で、HttpsPort が指定されている場合にのみ返されます。 |
| HttpPort | List | [80] | HTTP ポート。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| HttpToUserIp | Integer | 0 | オリジンサーバーへのリクエストに対して HTTPS から HTTP へのリダイレクトが有効になっているかどうかを指定します。有効な値:0: 無効。1: 有効。AccessType が waf-cloud-dns で、HttpsPort が指定されている場合にのみ返されます。 |
| HttpsPort | List | [443,8443] | HTTPS ポート。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| HttpsRedirect | Integer | 0 | HTTP から HTTPS へのリダイレクトが有効になっているかどうかを指定します。有効な値:0: 無効。1: 有効。AccessType が waf-cloud-dns で、HttpsPort が指定されている場合にのみ返されます。 |
| IpFollowStatus | Integer | 1 | WAF がリクエストと同じ IP アドレスタイプを使用してオリジンサーバーにリクエストを転送するかどうかを指定します。有効な値:0: 無効。1: 有効。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| IsAccessProduct | Integer | 1 | WAF の前にレイヤー 7 プロキシが設定されているかどうかを指定します。レイヤー 7 プロキシには、Anti-DDoS Pro、Anti-DDoS Premium、Alibaba Cloud CDN が含まれます。有効な値:0: レイヤー 7 プロキシは設定されていません。1: レイヤー 7 プロキシが設定されています。 |
| Keepalive | Boolean | true | 持続的接続が有効になっているかどうかを指定します。有効な値:true (デフォルト)。false。 |
| KeepaliveRequests | Integer | 1000 | 持続的接続あたりの最大リクエスト数。有効な値:60~1000。 |
| KeepaliveTimeout | Integer | 15 | 持続的接続のアイドルタイムアウト期間。単位:秒。有効な値:1~60。デフォルト値:15。 |
| LoadBalancing | Integer | 2 | オリジンサーバーにリクエストを転送するための負荷分散アルゴリズム。有効な値:0: IP ハッシュ。1: ラウンドロビン。2: 最小時間。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| ReadTime | Integer | 120 | WAF クラスターの読み取り接続タイムアウト期間。単位:秒。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| ResourceGroupId | String | rg-acfm2mkrunv**** | WAF インスタンスが属するリソースグループの ID。 |
| Retry | Boolean | true | 転送失敗後、WAF がオリジンサーバーへのリクエスト転送を再試行するかどうかを指定します。有効な値:true (デフォルト)。false。 |
| SniHost | String | waf.example.com | カスタムの Server Name Indication (SNI) フィールド値。空の場合、Host ヘッダーの値が使用されます。SniStatus が 1 の場合にのみ返されます。 |
| SniStatus | Integer | 1 | オリジン SNI が有効になっているかどうかを指定します。オリジン SNI は、WAF がオリジンサーバーにリクエストを転送するときに、TLS ハンドシェイク中に HTTPS 接続を確立するために使用されるドメイン名です。有効な値:0: 無効。1: 有効。AccessType が waf-cloud-dns で、HttpsPort が指定されている場合にのみ返されます。 |
| SourceIps | List | ["39.XX.XX.197"] | オリジンサーバーの IP アドレス。AccessType が waf-cloud-dns の場合にのみ返されます。 |
| Version | Long | 40 | ドメイン名設定のバージョン番号。 |
| WriteTime | Integer | 120 | WAF クラスターの書き込み接続タイムアウト期間。単位:秒。AccessType が waf-cloud-dns の場合にのみ返されます。 |
CloudNativeInstances (AccessType が waf-cloud-native の場合にのみ返されます)
| パラメーター | タイプ | 例 | 説明 |
|---|---|---|---|
| CloudNativeProductName | String | ALB | クラウドサービスインスタンスのタイプ。有効な値:SLB: Classic Load Balancer (CLB) インスタンス、旧称 Server Load Balancer (SLB)。ECS: Elastic Compute Service (ECS) インスタンス。ALB: Application Load Balancer (ALB) インスタンス。 |
| IPAddressList | String | ["39.XX.XX.197"] | クラウドサービスインスタンスのパブリック IP アドレス。 |
| InstanceId | String | alb-s65nua68wdedsp**** | クラウドサービスインスタンスの ID。 |
ProtocolPortConfigs (CloudNativeInstances 内)
| パラメーター | タイプ | 例 | 説明 |
|---|---|---|---|
| Ports | String | [80] | ポート。 |
| Protocol | String | http | プロトコル。有効な値:http。https。 |
| RedirectionTypeName | String | ALB | トラフィックリダイレクションポートのタイプ。有効な値:SLB-L4: CLB インスタンスのレイヤー 4 リスニングポート。SLB-L7: CLB インスタンスのレイヤー 7 リスニングポート。ECS: ECS インスタンスのリスニングポート。ALB: ALB インスタンスの HTTP および HTTPS リスニングポート。 |
LogHeaders (ドメイン名のトラフィックマーキングが有効になっている場合にのみ返されます)
| パラメーター | タイプ | 例 | 説明 |
|---|---|---|---|
| k | String | ALIWAF-TAG | カスタムヘッダーフィールドの名前。 |
| v | String | Yes | カスタムヘッダーフィールドの値。 |
例
リクエストの例
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
}
}エラーコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。