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

Web サイト設定を使用して、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。説明 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,8443]
HttpPorts	array	任意	HTTP のリッスンポートのリスト。
	integer	任意	HTTP のリッスンポートのリスト。フォーマットは [port1,port2,……] です。	[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	任意	追加する 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	任意	強制 HTTPS リダイレクトを有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく (ドメイン名が HTTPS を使用していることを示す)、かつ HttpPorts が空である (ドメイン名が HTTP を使用していないことを示す) 場合にのみ使用されます。有効な値: true: 強制 HTTPS リダイレクトが有効です。 false: 強制 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 アドレスの取得に使用されるカスタムヘッダーフィールドのリスト。フォーマットは ["header1","header2",……] です。説明このパラメーターは、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: 有効。 false: 無効。
HstsPreload	boolean	任意	HSTS プリロードを有効にするかどうかを指定します。この特徴はデフォルトで無効になっています。有効な値: true: 有効。 false: 無効。	false
HstsMaxAge	integer	任意	HSTS の有効期限時間。単位: 秒。	365000
Redirect	object	必須	転送構成。
Backends	array	任意	ドメイン名に対応するオリジンサーバーの IP アドレスまたは back-to-origin ドメイン名。
	string	任意	ドメイン名に対応するオリジンサーバーの IP アドレスまたは back-to-origin ドメイン名のセット。設定できるタイプは 1 つのみです (オリジンサーバー IP アドレスまたは back-to-origin ドメイン名)。back-to-origin アドレスがドメイン名の場合、IPv4 のみがサポートされます。IPv6 はサポートされません。オリジンサーバー IP アドレスを設定する場合、フォーマットは ["ip1","ip2",……] です。最大値は 20 個の IP アドレスです。 back-to-origin ドメイン名を設定する場合、フォーマットは ["domain"] です。最大値は 20 個のドメイン名アドレスです。	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	必須	back-to-origin に使用されるソース負荷分散アルゴリズムのセット。有効な値: iphash: IP ハッシュアルゴリズム。四捨五入は行われません。 roundRobin: ラウンドロビンアルゴリズム。 leastTime: 最短時間アルゴリズム。この値は、ProtectionResource が gslb (共有クラスターベースのインテリジェント負荷分散が使用されていることを示す) に設定されている場合にのみ使用できます。	roundRobin
FocusHttpBackend	boolean	任意	強制 HTTP back-to-origin を有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: true: 強制 HTTP back-to-origin が有効です。 false: 強制 HTTP back-to-origin は無効です。	true
SniEnabled	boolean	任意	back-to-オリジン SNI を有効にするかどうかを指定します。このパラメーターは、HttpsPorts が空ではなく、ドメイン名が HTTPS を使用している場合にのみ使用されます。有効な値: true: back-to-オリジン SNI が有効です。 false (デフォルト): back-to-オリジン SNI は無効です。	true
SniHost	string	任意	カスタムオリジン SNI 拡張フィールドの値のセット。このパラメーターが設定されていない場合、デフォルトでリクエストヘッダーの Host フィールドの値が SNI 拡張フィールドの値として使用されます。通常、サービスに特別な構成要件があり、WAF が back-to-origin リクエストで実際のリクエスト Host と異なる SNI (ここで設定したカスタム SNI) を使用するようにしたい場合を除き、SNI をカスタマイズする必要はありません。説明このパラメーターは、SniEnabled が true (back-to-origin SNI が有効であることを示す) に設定されている場合にのみ必須です。	www.aliyundoc.com
RequestHeaders	array<object>	任意	ドメイン名のトラフィックマークフィールドと値。WAF によって処理されたトラフィックをマークするために使用されます。カスタムリクエストヘッダーフィールドと対応する値を指定することで、ドメイン名のアクセストラフィックが WAF を通過する際、WAF は指定されたカスタムフィールド値をトラフィックマークとしてリクエストヘッダーに自動的に追加し、バックエンドサービスによる関連情報の収集を支援します。フォーマットは呼び出し時に指定します。
	object	任意	このパラメーターの値のフォーマットは [*{"k":"key","v":"value"}] です。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	任意	ハイブリッドクラウド転送ルールのセット。値は JSON 配列から変換された文字列です。JSON 配列内の各要素は、以下のフィールドを含む構造体です: rs: 配列タイプ \| back-to-origin IP アドレスまたは back-to-origin CNAME ドメイン名のリスト。 backupRs: 配列タイプ \| バックアップ back-to-origin IP アドレスまたは back-to-origin CNAME ドメイン名のリスト。このフィールドは必須です。バックアップが設定されていない場合は [] を使用します。 location: 文字列タイプ \| 保護ノードの名前。 locationId: Long タイプ \| 保護ノードの ID。	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	任意	持続的接続を有効にするかどうかを指定します。有効な値: true (デフォルト): 持続的接続が有効です。 false: 持続的接続は無効です。	true
Retry	boolean	任意	WAF がオリジンサーバーへのリクエスト転送に失敗した場合にリトライするかどうかを指定します。有効な値: true (デフォルト): リトライが有効です。 false: リトライは無効です。	true
KeepaliveRequests	integer	任意	持続的接続を再利用するリクエスト数。有効な値: 60～1000。デフォルト値: 1000。説明持続的接続が有効になった後に再利用される持続的接続の数。	1000
KeepaliveTimeout	integer	任意	持続的接続のアアイドルタイムアウト期間。有効な値: 1～60。デフォルト値: 15。単位: 秒。説明再利用された持続的接続がリリースされるまでのアイドル時間。	15
XffProto	boolean	任意	X-Forward-For-Proto を使用して WAF で使用されるプロトコルを渡すかどうかを指定します。有効な値: true (デフォルト): WAF で使用されるプロトコルが渡されます。 false: WAF で使用されるプロトコルは渡されません。	false
BackupBackends	array	任意	ドメイン名に対応するバックアップオリジンサーバー IP アドレスまたは back-to-origin ドメイン名。
	string	任意	ドメイン名に対応するバックアップオリジンサーバー IP アドレスまたは back-to-origin ドメイン名のセット。設定できるタイプは 1 つのみです (オリジンサーバー IP アドレスまたは back-to-origin ドメイン名)。back-to-origin アドレスがドメイン名の場合、IPv4 のみがサポートされます。IPv6 はサポートされません。オリジンサーバー IP アドレスを設定する場合、フォーマットは ["ip1","ip2",……] です。最大値は 20 個の IP アドレスです。 back-to-origin ドメイン名を設定する場合、フォーマットは ["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	任意	HTTP/2 back-to-origin を有効にするかどうかを指定します。有効な値: true: HTTP/2 back-to-origin が有効です。 false: HTTP/2 back-to-origin は無効です。	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 保持特徴が有効かどうかを指定します。 true: クライアントソース IP 保持特徴が有効です。この特徴を有効にすると、バックエンドサービスはクライアントの送信元 IP アドレスをビューできます。 false: クライアントソース IP 保持特徴は無効です。	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	追加されたドメイン名。	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 を同時に有効にできません。

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

変更履歴

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