Web Application Firewall (WAF) インスタンスにドメイン名を追加します。
デバッグ
リクエストパラメーター
| パラメーター | 型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | CreateDomain | 実行する操作を指定します。値は CreateDomain に設定してください。 |
| InstanceId | String | はい | waf-cn-7pp26f1**** | WAF インスタンスの ID を指定します。インスタンス ID の取得方法については、「DescribeInstanceInfo」操作をご参照ください。 |
| Domain | String | はい | www.example.com | WAF に追加するドメイン名を指定します。 |
| IsAccessProduct | Integer | はい | 0 | WAF の前にレイヤー 7 プロキシが構成されているかどうかを指定します。レイヤー 7 プロキシには、Anti-DDoS Pro、Anti-DDoS Premium、Alibaba Cloud CDN が含まれます。有効な値: 0:レイヤー 7 プロキシは構成されていません。1:レイヤー 7 プロキシが構成されています。 |
| AccessHeaderMode | Integer | いいえ | 0 | WAF が実際のクライアント IP アドレスを取得する方法を指定します。有効な値: 0(デフォルト):WAF が X-Forwarded-For(XFF)ヘッダーの最初の値を読み取ります。1:WAF がカスタムヘッダーフィールドを読み取ります。 重要 IsAccessProduct を 1 に設定した場合のみ必須です。 |
| AccessHeaders | String | いいえ | ["X-Client-IP"] | WAF が実際のクライアント IP アドレスを取得するために使用するカスタムヘッダーフィールドを指定します。形式: ["header1","header2",...]。重要 AccessHeaderMode を 1 に設定した場合のみ必須です。 |
| LogHeaders | String | いいえ | [{"k":"ALIWAF-TAG","v":"Yes"}] | WAF インスタンスを経由するリクエストにラベルを付けるためのキーと値のペアを指定します。形式: [{"k":"_key_","v":"_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",...]。重要 AccessType を waf-cloud-dns に設定した場合のみ必須です。ウェブサイトが HTTP を使用することを示します。HttpPort または HttpsPort のいずれかを指定する必要があります。 |
| HttpsPort | String | いいえ | [443] | HTTPS ポートを指定します。形式: ["port1","port2",...]。重要 AccessType を waf-cloud-dns に設定した場合のみ必須です。ウェブサイトが HTTPS を使用することを示します。HttpPort または HttpsPort のいずれかを指定する必要があります。 |
| HttpsRedirect | Integer | いいえ | 0 | HTTP から HTTPS へのリダイレクトを有効にするかどうかを指定します。有効にすると、リクエストはポート 443 上で HTTPS 経由で送信されます。有効な値: 0(デフォルト):無効。1:有効。 重要 AccessType を waf-cloud-dns に設定し、HttpsPort を指定した場合のみ必須です。 |
| Http2Port | String | いいえ | [443] | HTTP/2 ポートを指定します。形式: ["port1","port2",...]。重要 AccessType を waf-cloud-dns に設定し、HttpsPort を指定した場合のみ必須です。 |
| HttpToUserIp | Integer | いいえ | 0 | オリジンサーバーへの back-to-origin リクエストに対して HTTPS から HTTP へのリダイレクトを有効にするかどうかを指定します。有効にすると、WAF はポート 80 上で HTTP 経由でオリジンサーバーにリクエストを転送します。有効な値: 0(デフォルト):無効。1:有効。 重要 AccessType を waf-cloud-dns に設定し、HttpsPort を指定した場合のみ必須です。 |
| IpFollowStatus | Integer | いいえ | 1 | WAF がリクエスト内の IP アドレスの種類に基づいてオリジンサーバーにリクエストを転送するかどうかを指定します。有効にすると、IPv4 リクエストは IPv4 オリジンサーバーに、IPv6 リクエストは IPv6 オリジンサーバーに転送されます。有効な値: 0:無効。1:有効。 重要 AccessType を waf-cloud-dns に設定した場合のみ必須です。 |
| SourceIps | String | いいえ | ["39.XX.XX.197"] | オリジンサーバーの IP アドレスまたはドメイン名を指定します。IP アドレスまたはドメイン名のいずれか一方のみを指定してください。IP アドレスの形式: ["ip1","ip2",...]。最大 20 個まで指定可能です。ドメイン名の形式: ["domain"]。ドメイン名は 1 つだけ指定できます。重要 AccessType を waf-cloud-dns に設定した場合のみ必須です。 |
| LoadBalancing | Integer | いいえ | 0 | WAF がオリジンサーバーにリクエストを転送する際に使用する負荷分散アルゴリズムを指定します。有効な値: 0:IP ハッシュアルゴリズム。1:ラウンドロビンアルゴリズム。2:最小応答時間アルゴリズム。 重要 AccessType を waf-cloud-dns に設定した場合のみ必須です。 |
| 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 に設定した場合のみ必須です。 |
| CloudNativeInstances | String | いいえ | [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] | 透過型プロキシモードにおけるサーバーおよびポートの構成を JSON 配列文字列として指定します。各要素には以下のフィールドが含まれます:ProtocolPortConfigs(必須):プロトコルおよびポートの構成。各要素には以下のフィールドが含まれます:Ports(必須):ポート番号。形式: [port1,port2,...]。Protocol(必須):プロトコル。有効な値: http、https。CloudNativeProductName(必須):クラウドサービスインスタンスの種類。有効な値: ECS、SLB、ALB。RedirectionTypeName(必須):トラフィックリダイレクションポートの種類。有効な値: ECS、SLB-L4、SLB-L7、ALB。InstanceId(必須):クラウドサービスインスタンスの ID。IPAddressList(必須):クラウドサービスインスタンスのパブリック IP アドレス。形式: ["ip1","ip2",...]。重要 AccessType を waf-cloud-native に設定した場合のみ必須です。 |
| SniStatus | Integer | いいえ | 1 | オリジン Server Name Indication(SNI)を有効にするかどうかを指定します。オリジン SNI は、WAF がオリジンサーバーにリクエストを転送する際の HTTPS ハンドシェイクで使用されるドメイン名を指定します。オリジンサーバーが複数のドメイン名をホストしている場合に有効化します。有効な値: 0:無効。1:有効。デフォルトでは、中国本土の WAF インスタンスではオリジン SNI が無効化され、中国本土以外の WAF インスタンスでは有効化されます。 重要 AccessType を waf-cloud-dns に設定し、HttpsPort を指定した場合のみ必須です。 |
| SniHost | String | いいえ | waf.example.com | back-to-origin リクエストに対するカスタム SNI フィールド値を指定します。未指定の場合、WAF は Host ヘッダーの値を使用します。SNI フィールドの値が Host ヘッダーの値と異なる必要がある場合に、カスタム値を指定します。 重要 SniStatus を 1 に設定した場合のみ必須です。 |
| Retry | Boolean | いいえ | true | WAF がリクエストの転送に失敗した場合に再試行するかどうかを指定します。有効な値: true(デフォルト)、false。 |
| Keepalive | Boolean | いいえ | true | 接続保持を有効にするかどうかを指定します。有効な値: true(デフォルト)、false。 |
| KeepaliveRequests | Integer | いいえ | 1000 | 再利用可能な接続保持の回数を指定します。有効な値: 60 ~ 1000。 |
| KeepaliveTimeout | Integer | いいえ | 15 | 接続保持のアイドルタイムアウト期間を指定します。単位:秒。有効な値: 1 ~ 60。デフォルト値: 15。 |
すべての Alibaba Cloud API リクエストは、共通リクエストパラメーターを含める必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
応答要素
| パラメーター | 型 | 例 | 説明 |
|---|---|---|---|
| Cname | String | mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com | WAF がドメイン名に割り当てる CNAME を指定します。AccessType を waf-cloud-dns に設定した場合にのみ返されます。 |
| RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 | リクエスト ID を指定します。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=CreateDomain
&InstanceId=waf-cn-7pp26f1****
&Domain=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"
}エラーコード
エラーコードの一覧については、「API エラーセンター」をご参照ください。