Web サイト設定による保護のために、ドメイン名を WAF インスタンスに追加します。
操作説明
この操作を呼び出す前に、ドメイン名 (Domain) が以下の要件を満たしている必要があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
yundun-waf:CreateDomain |
create |
*ソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
WAF インスタンスの ID。 説明
DescribeInstance を呼び出して、現在の WAF インスタンスの ID を照会できます。 |
waf_cdnsdf3**** |
| ResourceManagerResourceGroupId |
string |
任意 |
Alibaba Cloud リソースグループの ID。 |
rg-acfm***q |
| Domain |
string |
必須 |
クエリするドメイン名。 |
www.aliyundoc.com |
| Listen |
object |
必須 |
リッスン設定のリスト。 |
|
| HttpsPorts |
array |
任意 |
HTTPS のリッスンポートのリスト。 |
|
|
integer |
任意 |
HTTPS のリッスンポートのリスト。フォーマットは [port1,port2,......,portN] です。 |
443 |
|
| HttpPorts |
array |
任意 |
HTTP のリッスンポートのリスト。 |
|
|
integer |
任意 |
HTTP のリッスンポートのリスト。フォーマットは [port1,port2,......] です。 |
80 |
|
| Http2Enabled |
boolean |
任意 |
HTTP/2 を有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: |
true |
| CertId |
string |
任意 |
追加する証明書の ID。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。 |
123 |
| SM2Enabled |
boolean |
任意 |
SM2 証明書を有効にするかどうかを指定します。 |
true |
| SM2CertId |
string |
任意 |
追加する SM2 証明書の ID。このパラメーターは、SM2Enabled が true に設定されている場合にのみ使用されます。 |
123-cn-hangzhou |
| SM2AccessOnly |
boolean |
任意 |
SM2 クライアントからのアクセスのみを許可するかどうかを指定します。このパラメーターは、SM2Enabled が true に設定されている場合にのみ使用されます。 |
true |
| TLSVersion |
string |
任意 |
追加する TLS バージョン。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS プロトコルを使用している場合にのみ使用されます。有効な値:
|
tlsv1 |
| EnableTLSv3 |
boolean |
任意 |
TLS 1.3 をサポートするかどうかを指定します。有効な値: |
true |
| CipherSuite |
integer |
任意 |
追加する暗号スイートのタイプ。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: |
2 |
| CustomCiphers |
array |
任意 |
追加するカスタム暗号スイート。 |
|
|
string |
任意 |
追加するカスタム暗号スイート。このパラメーターは、CipherSuite が 99 に設定されている場合にのみ使用されます。 |
ECDHE-ECDSA-AES256-SHA384 |
|
| FocusHttps |
boolean |
任意 |
強制 HTTPS リダイレクトを有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく (ドメイン名が HTTPS を使用していることを示す)、かつ HttpPorts が空である (ドメイン名が HTTP を使用していないことを示す) 場合にのみ使用されます。有効な値: |
true |
| XffHeaderMode |
integer |
任意 |
WAF がクライアントの送信元 IP アドレスを取得するために使用するメソッド。有効な値: |
1 |
| XffHeaders |
array |
任意 |
クライアント IP アドレスを取得するために使用されるカスタムヘッダーフィールド。 |
|
|
string |
任意 |
クライアント IP アドレスを取得するために使用されるカスタムヘッダーフィールド。フォーマットは ["header1","header2",......] です。 |
Client-ip |
|
| IPv6Enabled |
boolean |
任意 |
IPv6 を有効にするかどうかを指定します。有効な値: |
true |
| ProtectionResource |
string |
任意 |
使用する保護リソースのタイプ。有効な値: |
share |
| ExclusiveIp |
boolean |
任意 |
排他的 IP アドレスを有効にするかどうかを指定します。このパラメーターは、IPv6Enabled が false (IPv6 が無効であることを示す) に設定されており、かつ ProtectionResource が share (共有クラスターが使用されていることを示す) にセットされている場合にのみ使用されます。有効な値: |
true |
| HstsIncludeSubDomain |
boolean |
任意 |
HSTS にサブドメインを含めるかどうかを指定します。有効な値: |
true |
| HstsPreload |
boolean |
任意 |
HSTS プリロードを有効にするかどうかを指定します。この特徴はデフォルトで無効になっています。有効な値: |
false |
| HstsMaxAge |
integer |
任意 |
HSTS の有効時間。単位: 秒。 |
365000 |
| Redirect |
object |
必須 |
転送構成。 |
|
| Backends |
array |
任意 |
ドメイン名に対応するオリジンサーバーの IP アドレスまたはドメイン名。 |
|
|
string |
任意 |
ドメイン名に対応するオリジンサーバーの IP アドレスまたはドメイン名。設定できるのは、オリジンサーバー IP アドレスまたはオリジンサーバードメイン名のいずれか 1 つのタイプのみです。バックツーオリジンアドレスがドメイン名の場合、IPv4 のみがサポートされています。IPv6 はサポートされていません。 |
1.1.XX.XX |
|
| Loadbalance |
string |
必須 |
オリジンサーバーへのリクエストに使用される負荷分散アルゴリズム。有効な値:
|
四捨五入 |
| FocusHttpBackend |
boolean |
任意 |
強制 HTTP バックツーオリジンを有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: |
true |
| SniEnabled |
boolean |
任意 |
バックツーオリジンの Server Name Indication (SNI) を有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: |
true |
| SniHost |
string |
任意 |
カスタム SNI 拡張フィールドの値。このパラメーターを設定しない場合、デフォルトでリクエストヘッダーの Host フィールドの値が SNI 拡張フィールドの値として使用されます。 通常、SNI のカスタマイズは不要です。ただし、ビジネスに特別な設定要件があり、WAF がバックツーオリジンリクエストにおいて実際のリクエスト Host と異なる SNI(ここで設定したカスタム SNI)を使用する必要がある場合は例外です。 説明
このパラメーターは、SniEnabled が true(バックツーオリジン SNI が有効であることを示す)に設定されている場合にのみ必須です。 |
www.aliyundoc.com |
| RequestHeaders |
array<object> |
任意 |
ドメイン名のトラフィックマークヘッダーフィールドと値。WAF によって処理されたトラフィックをマークするために使用されます。 |
|
|
object |
任意 |
このパラメーターの値のフォーマットは [{"k":"key","v":"value"}] です。ここで、key はカスタムリクエストヘッダーフィールドを指定し、value はそのフィールドに設定された値を指定します。 |
||
| Key |
string |
任意 |
カスタムリクエストヘッダーフィールド。 |
aaa |
| Value |
string |
任意 |
カスタムリクエストヘッダーフィールドに設定された値。 |
bbb |
| ConnectTimeout |
integer |
任意 |
接続タイムアウト期間。単位: 秒。 |
120 |
| ReadTimeout |
integer |
任意 |
読み取りタイムアウト期間。単位: 秒。 |
200 |
| WriteTimeout |
integer |
任意 |
書き込みタイムアウト期間。単位: 秒。 |
200 |
| CnameEnabled |
boolean |
任意 |
パブリッククラウドのディザスタリカバリを有効にするかどうかを指定します。有効な値:
|
true |
| RoutingRules |
string |
任意 |
ハイブリッドクラウド転送ルール。値は JSON 配列から変換された文字列です。JSON 配列内の各要素は、以下のフィールドを含む構造体です: |
[ |
| Keepalive |
boolean |
任意 |
持続的接続を有効にするかどうかを指定します。有効な値: |
true |
| Retry |
boolean |
任意 |
WAF がオリジンサーバーへのリクエスト転送に失敗した場合にリトライするかどうかを指定します。有効な値: |
true |
| KeepaliveRequests |
integer |
任意 |
持続的接続を再利用するリクエスト数。有効な値: 60 ~ 1000。デフォルト値: 1000。 |
1000 |
| KeepaliveTimeout |
integer |
任意 |
持続的接続のアアイドルタイムアウト期間。有効な値: 1 ~ 60。デフォルト値: 15。単位: 秒。 |
15 |
| XffProto |
boolean |
任意 |
X-Forward-For-Proto を使用して WAF が使用するプロトコルを渡すかどうかを指定します。有効な値: |
false |
| BackupBackends |
array |
任意 |
ドメイン名に対応するセカンダリオリジンサーバーの IP アドレスまたはドメイン名。 |
|
|
string |
任意 |
ドメイン名に対応するセカンダリオリジンサーバーの IP アドレスまたはドメイン名。設定できるのは、オリジンサーバー IP アドレスまたはオリジンサーバードメイン名のいずれか 1 つのタイプのみです。バックツーオリジンアドレスがドメイン名の場合、IPv4 のみがサポートされています。IPv6 はサポートされていません。 |
2.2.XX.XX |
|
| XClientIp |
boolean |
任意 |
WAF による X-Client-IP の上書きを許可するかどうかを指定します。有効な値: |
true |
| XTrueIp |
boolean |
任意 |
WAF による X-True-IP の上書きを許可するかどうかを指定します。有効な値: |
true |
| WebServerType |
boolean |
任意 |
WAF による Web-Server-Type の上書きを許可するかどうかを指定します。有効な値: |
true |
| WLProxyClientIp |
boolean |
任意 |
WAF による WL-Proxy-Client-IP の上書きを許可するかどうかを指定します。有効な値: |
true |
| MaxBodySize |
integer |
任意 |
リクエストボディの最大値。有効な値: 2 ~ 10。デフォルト値: 2。単位: GB。 |
2 |
| Http2Origin |
boolean |
任意 |
HTTP/2 バックツーオリジンを有効にするかどうかを指定します。有効な値: |
true |
| Http2OriginMaxConcurrency |
integer |
任意 |
HTTP/2 バックツーオリジン接続の同時実行数の最大値。有効な値: 1 ~ 512。デフォルト値: 128。 |
128 |
| BackendPorts |
array<object> |
任意 |
カスタムポート構成。 |
|
|
object |
任意 |
カスタムポート構成。 |
||
| ListenPort |
integer |
任意 |
リッスンポートのリスト。 |
80 |
| BackendPort |
integer |
任意 |
バックツーオリジンポート。 |
80 |
| Protocol |
string |
任意 |
リッスンポートのプロトコルのリスト。有効な値: |
http |
| ProxyProtocol |
boolean |
任意 |
クライアントソース IP 保持機能が有効かどうかを示します。
|
false |
| RegionId |
string |
必須 |
WAF インスタンスが存在するリージョン。有効な値: |
cn-hangzhou |
| AccessType |
string |
任意 |
WAF インスタンスのアクセスタイプ。有効な値:
説明
値が share の場合、または値が hybrid_cloud_cname でパブリッククラウドディザスタリカバリが有効な場合は、まず DescribeVerifyContent および VerifyDomainOwner 操作を呼び出してドメイン名の所有権を確認してください。ドメイン名が中国本土のリージョンに接続されている場合は、ICP 登録も完了している必要があります。 |
share |
| Tag |
array<object> |
任意 |
タグのリスト。最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
リソースのタグ。最大 20 個のタグを指定できます。 |
||
| Key |
string |
任意 |
タグキー。 |
Tagkey1 |
| Value |
string |
任意 |
タグ値。 |
TagValue1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
ドメイン名追加後に返される応答。 |
||
| RequestId |
string |
リクエスト ID。 |
D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
| DomainInfo |
object |
追加されたドメイン名のフォーマット情報。 |
|
| Cname |
string |
WAF によってドメイン名に割り当てられた CNAME ドメイン名。 |
xxxxxwww.****.com |
| Domain |
string |
追加されたドメイン名の名前。 |
www.aliyundoc.com |
| DomainId |
string |
ドメイン名の ID。 |
www.aliyundoc.com-waf |
例
成功レスポンス
JSONJSON
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
"DomainInfo": {
"Cname": "xxxxxwww.****.com",
"Domain": "www.aliyundoc.com",
"DomainId": "www.aliyundoc.com-waf"
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Waf.Pullin.ResourceExsit | Access resource already exists, resource:%s. | 接続されたリソースはすでに存在します。既存リソース: %s。 |
| 400 | Waf.Pullin.BusinessViolation | The web services are suspected of violating regulations. If you have any questions, please submit a work order. Violating resource: %s. | サービスに違反の疑いがあります。ご不明な点がございましたら、チケットを起票してください。違反リソース: %s。 |
| 400 | Waf.Pullin.Http2OriginMustOnHttp2Enable | When HTTP2 origin is enabled, HTTP2 listening must be enabled. | HTTP/2 back-to-origin が有効な場合、HTTP/2 リスニングを有効にする必要があります。リストが無効です。 |
| 400 | Waf.Pullin.Http2OriginMustOnKeepaliveEnable | When the HTTP2 origin is turned on, the keepalive must be turned on. | HTTP/2 back-to-origin が有効な場合、キープアライブを有効にする必要があります。 |
| 400 | Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden | When HTTP2 origin is enabled, HTTP origin cannot be enabled. | HTTP/2 back-to-origin が有効な場合、HTTP back-to-origin は有効にできません。 |
| 400 | Waf.Pullin.BatchDnsScheduleCheckFailed | Batch dns scheduling is in progress, and access related operations are prohibited. | バッチ DNS スケジューリングが進行中です。接続に関連する操作は禁止されています。 |
| 400 | Waf.Pullin.InvalidMaxAgeWithPreload | HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000. | HstsMaxAge パラメーターが無効です。HstsPreload が True にロードされ、セットされている場合、HstsMaxAge は 31536000 以上である必要があります。 |
| 400 | Waf.Pullin.InvalidIncludeSubDomainWithPreload | The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true. | HstsIncludeSubDomain パラメーターが無効です。HstsPreload が true にロードされ、セットされている場合、HstsIncludeSubDomain も true にセットする必要があります。 |
| 400 | Waf.Pullin.InvalidCustomCiphers | Invalid custom cipher suite. | カスタム暗号スイートが無効です。 |
| 400 | Waf.Pullin.InvalidHttp2OriginWithProxyProtocol | http2Origin and proxyProtocol cannot be opened at the same time. | http2Origin と proxyProtocol を同時に有効にすることはできません。時間が無効です。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。