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

Web Application Firewall:ModifyDomain

最終更新日:May 24, 2024

ドメイン名の設定を変更する。

デバッグ

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

リクエストパラメーター

パラメーター

データ型

必須/任意

説明

操作

String

必須

ModifyDomain

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

ドメイン

String

必須

www.example.com

設定を変更するドメイン名。

説明

DescribeDomainNames操作を呼び出して、Web Application Firewall (WAF) に追加されたドメイン名を照会できます。

InstanceId

文字列

はい

waf-cn-7pp26f1 ****

WAFインスタンスのID。

説明

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

IsAccessProduct

Integer

必須

0

トラフィックがWAFインスタンスに到達する前にインバウンドトラフィックをフィルタリングするために使用されるレイヤー7プロキシをデプロイするかどうかを指定します。 サポートされているレイヤー7プロキシには、Anti-DDoS Pro、Anti-DDoS Premium、Alibaba Cloud CDNが含まれます。 設定可能な値は以下のとおりです。

  • 0: レイヤー7プロキシを設定しません

  • 1: configures a Layer 7 proxy

SourceIps

String

任意

["39.XX. XX.197"]

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

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

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。

LoadBalancing

Integer

任意

0

WAFがリクエストを配信元サーバーに転送するときに使用される負荷分散アルゴリズム。 設定可能な値は以下のとおりです。

  • 0: IPハッシュ

  • 1: ラウンドロビン

  • 2: least time

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。

HttpPort

String

任意

[80]

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。 このパラメーターを指定すると、WebサイトはHTTPを使用します。 HttpPortパラメーターとHttpsPortパラメーターの少なくとも1つを指定する必要があります。

HttpsPort

String

任意

[443]

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。 このパラメーターを指定すると、ウェブサイトはHTTPSを使用します。 HttpPortパラメーターとHttpsPortパラメーターの少なくとも1つを指定する必要があります。

Http2Port

String

任意

[443]

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、HttpsPortパラメーターが空でない場合にのみ、このパラメーターを指定する必要があります。 HttpsPortパラメーターが空でない場合、WebサイトはHTTPSを使用します。

HttpsRedirect

Integer

任意

0

HTTPリクエストをHTTPSリクエストにリダイレクトする機能を有効にするかどうかを指定します。 この機能を有効にすると、HTTPリクエストはポート443のHTTPSリクエストにリダイレクトされます。これはデフォルトで使用されます。 設定可能な値は以下のとおりです。

  • 0: 機能を無効にします。 デフォルト値です。

  • 1: 機能を有効にします。

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、HttpsPortパラメーターが空でない場合にのみ、このパラメーターを指定する必要があります。 HttpsPort パラメータが空でない場合、ウェブサイトは HTTPS を使用しています。

HttpToUserIp

Integer

任意

0

HTTPSリクエストをHTTPリクエストにリダイレクトする機能を有効にするかどうかを指定します。 この機能を有効にすると、HTTPSリクエストはポート80のHTTPリクエストにリダイレクトされ、デフォルトで使用されます。 設定可能な値は以下のとおりです。

  • 0: 機能を無効にします。 デフォルト値です。

  • 1: 機能を有効にします。

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、HttpsPortパラメーターが空でない場合にのみ、このパラメーターを指定する必要があります。 HttpsPortパラメーターが空でない場合、WebサイトはHTTPSを使用します。

AccessHeaderMode

Integer

任意

0

WAFがクライアントの実際のIPアドレスを取得するために使用するメソッド。 設定可能な値は以下のとおりです。

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

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

説明

IsAccessProductパラメーターが1に設定されている場合にのみ、パラメーターを指定する必要があります。

AccessHeaders

String

任意

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

クライアントの実際のIPアドレスを取得するために使用されるカスタムヘッダーフィールド。 Specify the value in the ["header1","header2",...] format.

説明

AccessHeaderModeパラメーターが1に設定されている場合にのみ、パラメーターを指定する必要があります。

LogHeaders

String

任意

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

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

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

WAFは、キーと値のペアをリクエストのヘッダーに自動的に追加します。 このようにして、WAFを通過するリクエストが識別されます。

説明

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

ClusterType

Integer

任意

0

WAF保護クラスターのタイプ。 設定可能な値は以下のとおりです。

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

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。

ConnectionTime

Integer

任意

5

WAF専用クラスターの接続のタイムアウト期間。 (単位:秒)

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、ClusterTypeパラメーターの値が1に設定されている場合にのみ、パラメーターを指定する必要があります。

ReadTime

Integer

任意

120

WAF専用クラスタの読み込み接続のタイムアウト時間。(単位:秒)

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、ClusterTypeパラメーターの値が1に設定されている場合にのみ、パラメーターを指定する必要があります。

WriteTime

Integer

任意

120

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、ClusterTypeパラメーターの値が1に設定されている場合にのみ、パラメーターを指定する必要があります。

AccessType

String

任意

waf-cloud-dns

ドメイン名の追加に使用されるモード。 設定可能な値は以下のとおりです。

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

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

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: トラフィックのリダイレクトポートのタイプ。 このフィールドは必須です。 Data type: string. 有効な値: ECSSLB-L4SLB-L7ALB

  • InstanceId: クラウドサービスインスタンスのID。 このフィールドは必須です。 Data type: string.

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

説明

AccessTypeパラメーターの値がwaf-cloud-nativeに設定されている場合にのみ、パラメーターを指定する必要があります。

IpFollowStatus

Integer

任意

0

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

  • 0: 機能を無効にします。 デフォルト値です。

  • 1: 機能を有効にします。

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定されている場合にのみ、パラメーターを指定する必要があります。

SniStatus

Integer

任意

1

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

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

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

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

説明

AccessTypeパラメーターの値がwaf-cloud-dnsに設定され、HttpsPortパラメーターが空でない場合にのみ、このパラメーターを指定する必要があります。 HttpsPort パラメータが空でない場合、ウェブサイトは HTTPS を使用しています。

SniHost

String

任意

waf.example.com

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

WAFでホストフィールドの値とは異なる値のSNIフィールドを使用する場合は、SNIフィールドにカスタム値を指定できます。

説明

このパラメーターは、SniStatusパラメーターの値が1に設定されている場合にのみ設定する必要があります。

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

サンプルリクエストの詳細についてはExamplesの項をご参照ください。

レスポンスパラメーター

パラメーター

データ型

説明

RequestId

String

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

リクエストの ID です。

リクエストの例

http(s)://[Endpoint]/?Action=ModifyDomain
&InstanceId=waf-cn-7pp26f1****
&Domain=www.example.com
&IsAccessProduct=0
&HttpPort=[\"80\"]
&SourceIps=[\"39.XX.XX.197\"]
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式

<ModifyDomainResponse>
      <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</ModifyDomainResponse>

JSON 形式

{
    "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。