CreateDomain を使用してドメインを追加する - Web Application Firewall (WAF)

Web Application Firewall (WAF) インスタンスにドメイン名を追加し、保護対象として登録します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-waf:CreateDomain

create

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 WAF インスタンスの ID を照会するには、DescribeInstance 操作を呼び出します。	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q
Domain	string	必須	追加するドメイン名。	www.aliyundoc.com
Listen	object	必須	リスニング構成。
HttpsPorts	array	任意	HTTPS のリスニングポート。
	integer	任意	HTTPS リスニングポート番号。	[443,8443]
HttpPorts	array	任意	HTTP のリスニングポート。
	integer	任意	HTTP リスニングポート番号。	[80,81]
Http2Enabled	boolean	任意	HTTP/2 の有効化状態を示します。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 true：HTTP/2 が有効です。 false（デフォルト）：HTTP/2 が無効です。	true
CertId	string	任意	証明書の ID。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。	123
SM2Enabled	boolean	任意	SM 証明書ベースの暗号化の有効化状態を示します。	true
SM2CertId	string	任意	SM 証明書の ID。このパラメーターは、SM2Enabled を true に設定した場合のみ利用可能です。	123-cn-hangzhou
SM2AccessOnly	boolean	任意	アクセスを SM 証明書ベースのクライアントのみに制限するかどうかを示します。このパラメーターは、SM2Enabled を true に設定した場合のみ利用可能です。有効な値は以下のとおりです。 true：SM 証明書ベースのクライアントのみがドメインにアクセスできます。 false：SM 証明書ベースおよび非 SM 証明書ベースの両方のクライアントがドメインにアクセスできます。	true
TLSVersion	string	任意	最小 Transport Layer Security (TLS) バージョン。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	任意	TLS 1.3 のサポート状態を示します。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 true：TLS 1.3 がサポートされます。 false：TLS 1.3 はサポートされません。	true
CipherSuite	integer	任意	暗号スイートの種類。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 1：すべての暗号スイート。 2：強力な暗号スイート。この値は、TLSVersion を tlsv1.2 に設定した場合にのみ利用可能です。 99：カスタム暗号スイート。	2
CustomCiphers	array	任意	カスタム暗号スイート。
	string	任意	カスタム暗号スイート。このパラメーターは、CipherSuite を 99 に設定した場合にのみ利用可能です。	["xxx","ffas"]
FocusHttps	boolean	任意	受信リクエストに対して HTTP から HTTPS への強制リダイレクトを有効にするかどうかを示します。このパラメーターは、HttpsPorts を指定し、HttpPorts を空欄にした場合にのみ利用可能です。有効な値は以下のとおりです。 true：HTTP から HTTPS への強制リダイレクトが有効です。 false：HTTP から HTTPS への強制リダイレクトが無効です。	true
XffHeaderMode	integer	任意	WAF がクライアントの送信元 IP アドレスを取得するために使用する方法。有効な値は以下のとおりです。 0（デフォルト）：クライアントトラフィックが WAF に到達する前に、他のレイヤー 7 プロキシを経由しません。 1：WAF が X-Forwarded-For（XFF）ヘッダー内の最初の値をクライアント IP アドレスとして使用します。 2：WAF が指定したカスタムヘッダーフィールドの値をクライアント IP アドレスとして使用します。	1
XffHeaders	array	任意	クライアントの送信元 IP アドレスを取得するために使用するカスタムヘッダーフィールド。
	string	任意	クライアントの送信元 IP アドレスを取得するために使用するカスタムヘッダーフィールド。説明このパラメーターは、XffHeaderMode を 2（WAF が指定したカスタムヘッダーフィールドの値をクライアント IP アドレスとして使用することを意味）に設定した場合にのみ必須です。	["Client-ip","cip"]
IPv6Enabled	boolean	任意	IPv6 の有効化状態を示します。有効な値は以下のとおりです。 true：IPv6 が有効です。 false（デフォルト）：IPv6 が無効です。	true
ProtectionResource	string	任意	保護リソースの種類。有効な値は以下のとおりです。 share（デフォルト）：共有クラスター。 gslb：共有クラスター向けのインテリジェントロードバランシング。	share
ExclusiveIp	boolean	任意	専用 IP アドレス機能の有効化状態を示します。このパラメーターは、IPv6Enabled を false（IPv6 が無効であることを意味）、かつ ProtectionResource を share（共有クラスターを使用することを意味）に設定した場合にのみ利用可能です。有効な値は以下のとおりです。 true：専用 IP アドレス機能が有効です。 false（デフォルト）：専用 IP アドレス機能が無効です。	true
HstsIncludeSubDomain	boolean	任意	HSTS がサブドメインを含むかどうかを示します。有効な値は以下のとおりです。 true：HSTS がサブドメインを含みます。 false：HSTS がサブドメインを含みません。
HstsPreload	boolean	任意	HSTS プリロードの有効化状態を示します。有効な値は以下のとおりです。 true：HSTS プリロードが有効です。 false：HSTS プリロードが無効です。	false
HstsMaxAge	integer	任意	HSTS の生存時間（TTL）。単位：秒。	365000
Redirect	object	必須	転送構成。
Backends	array	任意	オリジンサーバーの IP アドレスまたはドメイン名。
	string	任意	オリジンサーバーの IP アドレスまたはドメイン名。いずれか一方のアドレス形式のみ使用できます。ドメイン名形式を使用する場合は、そのドメイン名は IPv4 アドレスにのみ解決可能である必要があります。 IP アドレスを指定する場合は、["ip1","ip2",……] の形式で指定します。最大 20 個の IP アドレスを指定できます。ドメイン名を指定する場合は、["domain"] の形式で指定します。最大 20 個のドメイン名を入力できます。	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	必須	WAF がオリジンサーバーへリクエストを転送する際に使用する負荷分散アルゴリズム。有効な値は以下のとおりです。 iphash：IP ハッシュアルゴリズム。 roundRobin：ラウンドロビンアルゴリズム。 leastTime：Least Time アルゴリズム。この値は、ProtectionResource を gslb（共有クラスター向けのインテリジェントロードバランシングを使用することを意味）に設定した場合にのみ利用可能です。	roundRobin
FocusHttpBackend	boolean	任意	back-to-origin リクエストに対して HTTPS から HTTP への強制リダイレクトを有効にするかどうかを示します。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 true：back-to-origin リクエストに対して HTTPS から HTTP への強制リダイレクトが有効です。 false：back-to-origin リクエストに対して HTTPS から HTTP への強制リダイレクトが無効です。	true
SniEnabled	boolean	任意	back-to-origin リクエストに対してサーバ名表示（SNI）機能を有効にするかどうかを示します。このパラメーターは、HttpsPorts を指定した場合（ドメイン名が HTTPS を使用することを意味）のみ利用可能です。有効な値は以下のとおりです。 true：back-to-origin リクエストに対して SNI 機能が有効です。 false（デフォルト）：back-to-origin リクエストに対して SNI 機能が無効です。	true
SniHost	string	任意	SNI フィールドのカスタム値。このパラメーターを指定しない場合、リクエスト内の Host ヘッダーの値が SNI フィールドの値として使用されます。このパラメーターは任意です。back-to-origin リクエストにおいて、WAF が Host フィールドとは異なる SNI フィールド値を使用する必要がある場合、SNI フィールドのカスタム値を指定できます。説明このパラメーターは、SniEnabled を true（back-to-origin リクエストに対して SNI 機能が有効であることを意味）に設定した場合にのみ必須です。	www.aliyundoc.com
RequestHeaders	array<object>	任意	WAF インスタンスを通過するリクエストにラベルを付けるためのキーと値のペア。リクエストが WAF を通過すると、WAF は自動的にカスタムヘッダーフィールドをリクエストに追加してリクエストをマークします。これにより、バックエンドサービスは WAF によって処理されたリクエストを識別できます。
	object	任意	カスタムヘッダーフィールド。カスタムヘッダーフィールド名には key を、フィールド値には value を指定します。
Key	string	任意	カスタムヘッダーフィールドのキー。	aaa
Value	string	任意	カスタムヘッダーフィールドの値。	bbb
ConnectTimeout	integer	任意	接続タイムアウト期間。単位：秒。有効な値：1～3600。デフォルト値：5。	120
ReadTimeout	integer	任意	読み取り操作のタイムアウト期間。単位：秒。有効な値：1～3600。デフォルト値：120。	200
WriteTimeout	integer	任意	書き込み操作のタイムアウト期間。単位：秒。有効な値：1～3600。デフォルト値：120。	200
CnameEnabled	boolean	任意	ドメイン名に対するパブリッククラウドディザスタリカバリ機能の有効化状態を示します。有効な値は以下のとおりです。 true：パブリッククラウドディザスタリカバリ機能が有効です。 false（デフォルト）：パブリッククラウドディザスタリカバリ機能が無効です。	true
RoutingRules	string	任意	ハイブリッドクラウドモードの転送ルール。値には以下のフィールドが含まれます。 rs：オリジンサーバーの IP アドレスまたは CNAME。 backupRs：オリジンサーバーのバックアップ IP アドレスまたは CNAME。必須項目。空の配列 [] はバックアップ未設定を意味します。 location：保護ノードの名前。 locationId：保護ノードの ID。	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	任意	持続的接続機能の有効化状態を示します。有効な値は以下のとおりです。 true（デフォルト）：持続的接続機能が有効です。 false：持続的接続機能が無効です。	true
Retry	boolean	任意	WAF がオリジンサーバーへのリクエスト転送に失敗した場合に再試行するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：WAF が再試行します。 false：WAF が再試行しません。	true
KeepaliveRequests	integer	任意	再利用可能な持続的接続の数。有効な値：60～1000。デフォルト値：1000。説明持続的接続機能が有効化された後の再利用可能な持続的接続の数。	1000
KeepaliveTimeout	integer	任意	アイドル状態の持続的接続のタイムアウト期間。有効な値：1～60。デフォルト値：15。単位：秒。説明再利用可能な持続的接続がアイドル状態を維持できる時間。この時間を超えると、持続的接続は閉じられます。	15
XffProto	boolean	任意	WAF がオリジンサーバーへリクエストを転送する際に使用するプロトコルを特定するために X-Forward-For-Proto ヘッダーを使用するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：X-Forward-For-Proto ヘッダーを使用してプロトコルを特定します。 false：X-Forward-For-Proto ヘッダーは使用しません。	false
BackupBackends	array	任意	オリジンサーバーのセカンダリ IP アドレスまたはドメイン名。
	string	任意	オリジンサーバーのセカンダリ IP アドレスまたはドメイン名。いずれか一方のアドレス形式のみ使用できます。ドメイン名形式を使用する場合は、そのドメイン名は IPv4 アドレスにのみ解決可能である必要があります。 IP アドレスを指定する場合は、["ip1","ip2",……] の形式で指定します。最大 20 個の IP アドレスを指定できます。ドメイン名を指定する場合は、["domain"] の形式で指定します。最大 20 個のドメイン名を入力できます。	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	任意	WAF が X-Client-IP ヘッダーを上書きすることを許可するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：WAF がヘッダーを上書きします。 false：WAF がヘッダーを上書きしません。	true
XTrueIp	boolean	任意	WAF が X-True-IP ヘッダーを上書きすることを許可するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：WAF がヘッダーを上書きします。 false：WAF がヘッダーを上書きしません。	true
WebServerType	boolean	任意	WAF が Web-Server-Type ヘッダーを上書きすることを許可するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：WAF がヘッダーを上書きします。 false：WAF がヘッダーを上書きしません。	true
WLProxyClientIp	boolean	任意	WAF が WL-Proxy-Client-IP ヘッダーを上書きすることを許可するかどうかを示します。有効な値は以下のとおりです。 true（デフォルト）：WAF がヘッダーを上書きします。 false：WAF がヘッダーを上書きしません。	true
MaxBodySize	integer	任意	リクエストボディの最大サイズ。有効な値：2～10。デフォルト値：2。単位：GB。説明このパラメーターは Ultimate エディションでのみサポートされます。	2
Http2Origin	boolean	任意	back-to-origin トラフィックに対して HTTP/2 を有効にするかどうかを示します。有効な値は以下のとおりです。 true：back-to-origin トラフィックに対して HTTP/2 が有効です。 false：back-to-origin トラフィックに対して HTTP/2 が無効です。	true
Http2OriginMaxConcurrency	integer	任意	同時実行可能な HTTP/2 back-to-origin リクエストの最大数。有効な値：1～512。デフォルト値：128。	128
BackendPorts	array<object>	任意	カスタムポート構成。
	object	任意	カスタムポート構成。
ListenPort	integer	任意	リスナーポート。	80
BackendPort	integer	任意	back-to-origin ポート。	80
Protocol	string	任意	リスナーポートのプロトコル。有効な値は以下のとおりです。 http：HTTP。 https：HTTPS。	http
ProxyProtocol	boolean	任意	クライアントの送信元 IP アドレスを保持するために Proxy Protocol 機能を有効にするかどうかを示します。有効な値は以下のとおりです。 true：Proxy Protocol 機能が有効です。この機能を有効化すると、バックエンドサービスがクライアントの元の IP アドレスを確認できます。 false：Proxy Protocol 機能が無効です。	false
RegionId	string	必須	WAF インスタンスが配置されているリージョン。有効な値は以下のとおりです。 cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
AccessType	string	任意	WAF インスタンスのアクセスタイプ。有効な値は以下のとおりです。 share（デフォルト）：CNAME レコードによるオンボード。 hybrid_cloud_cname：ハイブリッドクラウド CNAME レコードによるオンボード。	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	WAF にオンボードされたドメイン名。	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.
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.
400	Waf.Pullin.Http2OriginMustOnHttp2Enable	When HTTP2 origin is enabled, HTTP2 listening must be enabled.
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.
400	Waf.Pullin.BatchDnsScheduleCheckFailed	Batch dns scheduling is in progress, and access related operations are prohibited.
400	Waf.Pullin.InvalidMaxAgeWithPreload	HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000.
400	Waf.Pullin.InvalidIncludeSubDomainWithPreload	The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true.
400	Waf.Pullin.InvalidCustomCiphers	Invalid custom cipher suite.
400	Waf.Pullin.InvalidHttp2OriginWithProxyProtocol	http2Origin and proxyProtocol cannot be opened at the same time.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。