すべてのプロダクト
Search
ドキュメントセンター

Web Application Firewall:DescribeDomain

最終更新日:May 24, 2024

Web Application Firewall (WAF) に追加されたドメイン名の設定を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 利便性を考慮して、この操作は 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を照会できます。

すべてのAlibaba Cloud APIリクエストには、共通のリクエストパラメーターが含まれている必要があります。 共通リクエストパラメーターの詳細については、「共通リクエストパラメーター」をご参照ください。

サンプルリクエストの詳細については、このトピックの「」を参照してください。

レスポンスパラメーター

パラメーター

データ型

説明

RequestId

String

D827FCFE-90A7-4330-9326-D33C8B4C7726

リクエストの ID。

Domain

Struct

ドメイン名の設定。

AccessHeaderMode

Integer

1

クライアントの実際のIPアドレスを取得するために使用されるメソッド。 有効な値:

  • 0: WAFは、X-Forwarded-For (XFF) ヘッダーフィールドの最初の値をクライアントの実際のIPアドレスとして読み取ります。

  • 1: WAFは、カスタムヘッダーフィールドの値をクライアントの実際のIPアドレスとして読み取ります。

説明

このパラメーターは、IsAccessProductの値が1の場合にのみ返されます。

AccessHeaders

List

["X-クライアント-IP"]

クライアントの実際のIPアドレスを取得するために使用されるカスタムヘッダーフィールド。

説明

このパラメーターは、AccessHeaderModeの値が1の場合にのみ返されます。

AccessType

String

waf-cloud-dns

ドメイン名をWAFに追加するために使用されるモード。 有効な値:

  • waf-cloud-dns: CNAMEレコードモード。

  • waf-cloud-native: 透過プロキシモード。

CloudNativeInstances

CloudNativeInstancesの配列

透過プロキシモードでWAFに追加されたインスタンス。

説明

このパラメーターは、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

ProtocolPortConfigsの配列

プロトコルとポートの設定。

Ports

String

[80]

ポート。

Protocol

String

http

プロトコルの種類 有効な値:

  • http

  • https

RedirectionTypeName

String

ALB

トラフィック転送ポートのタイプ。 有効な値:

  • SLB-L4: CLBインスタンスのレイヤー4リスニングポートのトラフィックがWAFにリダイレクトされます。

  • SLB-L7: CLBインスタンスのレイヤー7リスニングポートのトラフィックがWAFにリダイレクトされます。

  • ECS: ECSインスタンスのリスニングポートのトラフィックがWAFにリダイレクトされます。

  • ALB: ALBインスタンスのHTTPおよびHTTPSリスニングポートのトラフィックがWAFにリダイレクトされます。

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

back-to-originリクエストのHTTPSからHTTPへのリダイレクトが有効かどうかを示します。 有効な値:

  • 0: back-to-originリクエストのHTTPSからHTTPへのリダイレクトは無効です。

  • 1: back-to-originリクエストのHTTPSからHTTPへのリダイレクトが有効になっています。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsで、HttpsPortが指定されている場合にのみ返されます。

HttpsPort

List

[443,8443]

HTTPSポート。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

HttpsRedirect

Integer

0

HTTPからHTTPSへのリダイレクトが有効かどうかを示します。 有効な値:

  • 0: HTTPからHTTPSへのリダイレクトは無効です。

  • 1: HTTPからHTTPSへのリダイレクトが有効になっています。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsで、HttpsPortが指定されている場合にのみ返されます。

IpFollowStatus

Integer

1

リクエストで指定されたIPアドレスタイプを使用するオリジンサーバーにリクエストを転送する機能が有効になっているかどうかを示します。 有効な値:

  • 0: リクエストで指定されたIPアドレスタイプを使用するオリジンサーバーにリクエストを転送する機能は無効になっています。

  • 1: リクエストで指定されたIPアドレスタイプを使用するオリジンサーバーにリクエストを転送する機能が有効になっています。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

IsAccessProduct

Integer

1

トラフィックがWAFインスタンスに送信される前にインバウンドトラフィックをフィルタリングするために使用されるレイヤー7プロキシが設定されているかどうかを示します。 レイヤー7プロキシには、Anti-DDoS Pro、Anti-DDoS Premium、Alibaba Cloud CDNが含まれます。 有効な値:

  • 0: レイヤ7プロキシは設定されていません。

  • 1: レイヤー7プロキシが設定されています。

LoadBalancing

Integer

2

リクエストを配信元サーバーに転送するために使用される負荷分散アルゴリズム。 有効な値:

  • 0: IPハッシュアルゴリズム。

  • 1: ラウンドロビンアルゴリズム。

  • 2: 最小時間アルゴリズム。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

LogHeaders

LogHeaderの配列

WAFインスタンスを通過するリクエストをマークするために使用するキーと値のペア。

説明

このパラメーターは、ドメイン名に対してトラフィックマーキング機能が有効になっている場合にのみ返されます。

k

String

ALIWAF-TAG

カスタムヘッダーフィールドの名前。

v

String

必須

カスタムヘッダーフィールドの値。

ReadTime

Integer

120

WAFクラスターの読み取り接続のタイムアウト期間。 単位は秒です。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

ResourceGroupId

String

rg-acfm2mkrunv ****

WAFインスタンスが属するリソースグループのID。

SniHost

String

waf.example.com

カスタムサーバー名表示 (SNI) フィールドの値。 このパラメーターが空の場合、リクエストヘッダーのHostフィールドの値がSNIフィールドの値として使用されます。

説明

このパラメーターは、SniStatusの値が1の場合にのみ返されます。

SniStatus

Integer

1

オリジンSNIが有効かどうかを示します。 オリジンSNIは、WAFがリクエストをオリジンサーバーに転送するときに、ハンドシェーキングプロセスの開始時にHTTPS接続を確立する必要があるドメイン名を示します。 有効な値:

  • 0: オリジンSNIは無効です。

  • 1: オリジンSINが有効です。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsで、HttpsPortが指定されている場合にのみ返されます。

SourceIps

List

["39.XX. XX.197"]

配信元サーバーのアドレス。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

Version

Long

40

ドメイン名設定のバージョン。

WriteTime

Integer

120

WAFクラスターの書き込み接続のタイムアウト期間。 単位は秒です。

説明

このパラメーターは、AccessTypeの値がwaf-cloud-dnsの場合にのみ返されます。

再試行

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
&Domai n=www.example.com
&InstanceId=waf-cn-7pp26f1 ****
&<共通リクエストパラメーター> 

成功レスポンスの例

XML 形式

<DescribeDomainResponse>
<RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>
<ドメイン>
<HttpToUserIp>0</HttpToUserIp>
<HttpPort>80</HttpPort>
<IsAccessProduct>1</IsAccessProduct>
<AccessHeaderMode>1</AccessHeaderMode>
<ResourceGroupId>rg-acfm2mkrunv ****</ResourceGroupId>
<AccessHeaders>Xクライアント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> はい </v>
<k>ALIWAF-TAG</k>
</LogHeaders>
<WriteTime>120</WriteTime>
<Http2Port>443</Http2Port>
<Http2Port>8443</Http2Port>
<バージョン> 40</バージョン>
<HttpsRedirect>0</HttpsRedirect>
<ConnectionTime>5</ConnectionTime>
<AccessType>waf-cloud-dns</AccessType>
<HttpsPort>443</HttpsPort>
<HttpsPort>8443</HttpsPort>
        <Keepalive>true</Keepalive>
        <KeepaliveTimeout>15</KeepaliveTimeout>
        <リトライ> true</リトライ>
        <KeepaliveRequests>1000</KeepaliveRequests>
</ドメイン>
</DescribeDomainResponse> 

JSON 形式

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C7726" 、
  "ドメイン": {
    "HttpToUserIp": 0、
    "HttpPort": [
      80
    ],
    "IsAccessProduct": 1、
    "AccessHeaderMode": 1、
    "ResourceGroupId": "rg-acfm2mkrunv ****" 、
    "AccessHeaders": [
      「X-クライアント-IP」
    ],
    "ReadTime": 120、
    "SourceIps": [
      「39.XX. XX.197」
    ],
    "IpFollowStatus": 1、
    "ClusterType": 0、
    "LoadBalancing": 2、
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com" 、
    "LogHeaders": [
      {
        "v": "はい" 、
        "k": "ALIWAF-TAG"
      }
    ],
    "WriteTime": 120、
    "Http2Port": [
      443,
      8443
    ],
    "バージョン": 40、
    "HttpsRedirect": 0、
    "ConnectionTime": 5、
    "AccessType": "waf-cloud-dns" 、
    "HttpsPort": [
      443,
      8443
    ],
    "Keepalive": true、
    "KeepaliveTimeout": 15、
    "SniStatus": 0、
    "再試行": true、
    "KeepaliveRequests": 1000
  }
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。