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

Web Application Firewall:CreateDomain

最終更新日:May 24, 2024

Web Application Firewall (WAF) インスタンスにドメイン名を追加します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター

データ型

必須

説明

Action

String

必須

CreateDomain

実行する操作です。 値をCreateDomainに設定します。

InstanceId

String

必須

waf-cn-7pp26f1 ****

WAFインスタンスのID。

説明

DescribeInstanceInfo操作を呼び出して、WAFインスタンスのIDを取得できます。

Domain

String

必須

www.example.com

WAFに追加するドメイン名。

IsAccessProduct

Integer

0

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

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

  • 1: レイヤ7プロキシはWAFの前に設定されています。

AccessHeaderMode

Integer

任意

0

クライアントの実際のIPアドレスを取得するためにWAFが使用する方法。 有効な値:

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

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

説明

このパラメーターは、IsAccessProduct1に設定した場合にのみ必要です。

AccessHeaders

String

任意

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

クライアントの実際のIPアドレスを取得するためにWAFが使用するカスタムヘッダーフィールド。 値を ["header1","header2",...] 形式で指定します。

説明

このパラメーターは、AccessHeaderMode1に設定した場合にのみ必要です。

LogHeaders

String

任意

[{"k":"ALIWAF-TAG","v":"はい"}]

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

キーと値のペアを [{"k":"_key_","v":"_value_"}] 形式で指定します。 _key_ はカスタムヘッダーフィールド、_value_ はカスタムヘッダーフィールドの値です。

WAFは自動的にキーと値のペアをリクエストヘッダーに追加します。 これにより、バックエンドサービスはWAFを通過するリクエストを識別できます。

説明

リクエストにカスタムヘッダーフィールドが含まれている場合、WAFはフィールドの元の値を指定された値で上書きします。

ResourceGroupId

String

任意

rg-atstuj3rtop ****

リソース管理のWAFインスタンスが属するリソースグループのID。 デフォルトでは、このパラメーターは空で、インスタンスがデフォルトのリソースグループに属することを指定します。

リソースグループの詳細については、「リソースグループの作成」をご参照ください。

AccessType

String

任意

waf-cloud-dns

ドメイン名をWAFに追加するモード。 有効な値:

  • waf-cloud-dns: CNAMEレコードモード。 デフォルト値です。

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

HttpPort

String

任意

[80]

HTTPポート。 値を ["port1","port2",...] 形式で指定します。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。 このパラメーターを指定すると、WebサイトはHTTPを使用します。 HttpPortまたはHttpsPortを指定する必要があります。

HttpsPort

String

任意

[443]

HTTPSポート。 値を ["port1","port2",...] 形式で指定します。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。 このパラメーターを指定すると、ウェブサイトはHTTPSを使用します。 HttpPortまたはHttpPortを指定する必要があります。

HttpsRedirect

Integer

任意

0

HTTPからHTTPSへのリダイレクトを有効にするかどうかを指定します。 HTTPからHTTPSへのリダイレクトを有効にすると、リクエストはHTTPS経由で送信されます。 デフォルトのポートは443です。 有効な値:

  • 0: HTTPからHTTPSへのリダイレクトを無効にします。

  • 1: HTTPからHTTPSへのリダイレクトを有効にします。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定し、HttpsPortを指定した場合にのみ必要です。

Http2Port

String

任意

[443]

HTTP/2ポート。 値を ["port1","port2",...] 形式で指定します。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定し、HttpsPortを指定した場合にのみ必要です。

HttpToUserIp

Integer

任意

0

back-to-originリクエストに対してHTTPSからHTTPへのリダイレクトを有効にするかどうかを指定します。 back-to-originリクエストに対してHTTPSからHTTPへのリダイレクトを有効にすると、WAFはリクエストをHTTP経由でオリジンサーバーに転送します。 デフォルトのポートは80です。 有効な値:

  • 0: back-to-originリクエストのHTTPSからHTTPへのリダイレクトを無効にします。 デフォルト値です。

  • 1: back-to-originリクエストのHTTPSからHTTPへのリダイレクトを有効にします。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定し、HttpsPortを指定した場合にのみ必要です。

IpFollowStatus

Integer

いいえ

1

リクエストで指定されたIPアドレスタイプを使用するオリジンサーバーにリクエストを転送する機能を有効にするかどうかを指定します。 この機能を有効にすると、WAFはIPv4アドレスからのリクエストをIPv4アドレスを使用するオリジンサーバーに転送し、IPv6アドレスからのリクエストをIPv6アドレスを使用するオリジンサーバーに転送します。 有効な値:

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

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

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。

SourceIps

String

任意

["39.XX. XX.197"]

オリジンサーバーのIPアドレスまたはドメイン名。 指定できるアドレスは1種類だけです。

  • IPアドレスを使用する場合は、["ip1","ip2",...] 形式で値を指定します。 最大20個のIPアドレスを指定できます。

  • ドメイン名を使用する場合は、["domain"] 形式で値を指定します。 ドメイン名は1つだけ入力できます。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。

LoadBalancing

Integer

任意

0

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

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

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

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

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。

ClusterType

Integer

任意

0

WAF保護クラスターのタイプ。 有効な値:

  • 0: 共有クラスター。 デフォルト値です。

  • 1: 排他的クラスター。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ必要です。

ConnectionTime

Integer

任意

5

WAF専用クラスターの接続のタイムアウト期間。 単位は秒です。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに、ClusterType1に設定した場合にのみ必要です。

ReadTime

Integer

任意

120

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

説明

このパラメーターは、AccessTypewaf-cloud-dnsに、ClusterType1に設定した場合にのみ必要です。

WriteTime

Integer

任意

120

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

説明

このパラメーターは、AccessTypewaf-cloud-dnsに、ClusterType1に設定した場合にのみ必要です。

CloudNativeInstances

String

任意

[{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp ****","IPAddressList":["182.XX. XX.113"],"CloudNativeProductName":"ALB"

透過プロキシモードのサーバーとポートの設定のリスト。 値をJSON配列で構成される文字列に設定します。 JSON配列の各要素は、次のフィールドを含むJSON構造体です。

  • ProtocolPortConfigs: プロトコルとポートの設定のリスト。 このフィールドは必須です。 データ型: 配列。 JSON配列の各要素は、次のフィールドを含むJSON構造体です。

    • ポート: ポートのリスト。 このフィールドは必須です。 データ型: 配列。 値を [port1,port2,…] 形式で指定します。

    • Protocol: プロトコル。 このフィールドは必須です。 データ型: 文字列。 有効な値: httpおよびhttps

  • CloudNativeProductName: クラウドサービスインスタンスのタイプ。 このフィールドは必須です。 データ型: 文字列。 有効な値: ECSSLB、およびALB

  • RedirectionTypeName: トラフィックのリダイレクトポートのタイプ。 このフィールドは必須です。 データ型: 文字列。 有効な値: ECSSLB-L4SLB-L7ALB

  • InstanceId: クラウドサービスインスタンスのID。 このフィールドは必須です。 データ型: 文字列。

  • IPAddressList: クラウドサービスインスタンスのパブリックIPアドレスのリスト。 このフィールドは必須です。 データ型: 配列。 値は ["ip1","ip2",...] 形式です。

説明

このパラメーターは、AccessTypewaf-cloud-nativeに設定した場合にのみ必要です。

SniStatus

Integer

いいえ

1

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

  • 0: オリジンSNIを無効にします。

  • 1: オリジンSNIを有効にします。

デフォルトでは、オリジンSNIは中国本土のWAFインスタンスでは無効になり、中国本土以外のWAFインスタンスでは有効になります。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定し、HttpsPortを指定した場合にのみ必要です。

SniHost

String

任意

waf.example.com

カスタムSNIフィールドの値。 このパラメーターを指定しないと、リクエストヘッダーのHostフィールドの値がSNIフィールドの値として自動的に使用されます。

back-to-originリクエストのHostフィールド値とは異なるSNIフィールド値をWAFで使用する場合は、SNIフィールドにカスタム値を指定できます。

説明

このパラメーターは、SniStatus1に設定した場合にのみ必要です。

Retry

ブール値

任意

true

リクエストがオリジンサーバーに転送されない場合に、WAFがリクエストの転送を再試行するかどうかを指定します。 有効な値:

  • true (デフォルト)

  • false

Keepalive

ブール値

任意

true

永続接続機能を有効にするかどうかを指定します。 有効な値:

  • true (デフォルト)

  • false

KeepaliveRequests

Integer

任意

1000

再利用される永続接続の数。 有効値: 60 ~ 1000

説明

永続接続機能が有効になった後に再利用される永続接続の数。

KeepaliveTimeout

Integer

任意

15

アイドル状態にある永続的な接続のタイムアウト期間。 単位は秒です。 有効な値: 1 ~ 60。 デフォルト値:15。

説明

持続的接続が解放される前に、再使用された持続的接続がアイドル状態に留まることができる期間。

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

サンプルリクエストを表示するには、このトピックの「」セクションを参照してください。

レスポンスパラメーター

パラメーター

データ型

説明

Cname

String

mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com

WAFによってドメイン名に割り当てられたCNAME。

説明

このパラメーターは、AccessTypewaf-cloud-dnsに設定した場合にのみ返されます。

RequestId

String

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

リクエストの ID。

リクエストの例

http(s)://[Endpoint]/?Action=CreateDomain
&InstanceId=waf-cn-7pp26f1 ****
&Domai n=www.example.com
&IsAccessProduct=0
&HttpPort=[\"80\"]
&SourceIps=[\"39.XX. XX.197\"]
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<CreateDomainResponse>
<Cname>mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com</Cname>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</CreateDomainResponse> 

JSON 形式

{
"Cname": "mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com" 、"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
} 

エラーコード

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