CreateDomain - - Alibaba Cloud ドキュメントセンター

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 です。説明 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	任意	追加する 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 アドレスを取得するために使用されるカスタムヘッダーフィールドです。形式は ["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: HSTS プリロードを有効にします。 false: HSTS プリロードを無効にします。
HstsMaxAge	integer	任意	HSTS の生存時間 (TTL) です。単位: 秒。	365000
Redirect	object	必須	転送設定。
Backends	array	任意	オリジンサーバーの IP アドレスまたはドメイン名です。
	string	任意	オリジンサーバーの IP アドレスまたはドメイン名です。アドレスタイプは 1 つのみ使用できます。ドメイン名タイプを使用する場合、ドメイン名は IPv4 アドレスにのみ解決できます。 IP アドレスを指定するには、["ip1","ip2",……] の形式を使用します。最大 20 個の IP アドレスを指定できます。ドメイン名を指定するには、["domain"] の形式を使用します。最大 20 個のドメイン名を入力できます。	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	必須	WAF がオリジンサーバーにリクエストを転送する際に使用するロードバランシングアルゴリズムです。有効な値は次のとおりです。 iphash: IPHash アルゴリズム。 roundRobin: ポーリングアルゴリズム。 leastTime: 最小時間アルゴリズム。この値は、ProtectionResource を gslb に設定した場合 (共有クラスターのインテリジェントロードバランシングが使用されていることを示します) にのみ使用できます。	roundRobin
FocusHttpBackend	boolean	任意	オリジンへのリクエストに対して HTTPS から HTTP への強制リダイレクトを有効にするかどうかを指定します。このパラメーターは、HttpsPorts を指定した場合 (ドメイン名が HTTPS を使用していることを示します) にのみ使用できます。有効な値は次のとおりです。 true: オリジンへのリクエストに対して HTTPS から HTTP への強制リダイレクトを有効にします。 false: オリジンへのリクエストに対して HTTPS から HTTP への強制リダイレクトを無効にします。	true
SniEnabled	boolean	任意	オリジンへのリクエストに対して Server Name Indication (SNI) 機能を有効にするかどうかを指定します。このパラメーターは、HttpsPorts を指定した場合 (ドメイン名が HTTPS を使用していることを示します) にのみ使用できます。有効な値は次のとおりです。 true: オリジンへのリクエストに対して SNI 機能を有効にします。 false (デフォルト): オリジンへのリクエストに対して SNI 機能を無効にします。	true
SniHost	string	任意	SNI フィールドのカスタム値です。このパラメーターを指定しない場合、リクエストの Host ヘッダーの値が SNI フィールドの値として使用されます。このパラメーターはオプションです。WAF がオリジンへのリクエストで Host フィールドの値とは異なる SNI フィールドの値を使用するようにしたい場合は、SNI フィールドにカスタム値を指定できます。説明このパラメーターは、SniEnabled を true に設定した場合 (オリジンへのリクエストに対して SNI 機能が有効になっていることを示します) にのみ必須です。	www.aliyundoc.com
RequestHeaders	array<object>	任意	WAF インスタンスを通過するリクエストにラベルを付けるために使用するキーと値のペアです。リクエストが 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: 配列 \| オリジンサーバーの IP アドレスまたは CNAME ドメイン名。 backupRs: 配列 \| オリジンサーバーのバックアップ IP アドレスまたは 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 がオリジンサーバーへのリクエストの転送に失敗した場合に、WAF がリトライするかどうかを指定します。有効な値は次のとおりです。 true (デフォルト): リトライします。 false: リトライしません。	true
KeepaliveRequests	integer	任意	再利用される持続的接続の数です。有効な値: 60～1000。デフォルト値: 1000。説明持続的接続機能が有効になった後に再利用される持続的接続の数です。	1000
KeepaliveTimeout	integer	任意	アイドル状態の持続的接続のタイムアウト期間です。有効な値: 1～60。デフォルト値: 15。単位: 秒。説明このパラメーターは、再利用される持続的接続が閉じられる前にアイドル状態を維持できる時間を指定します。	15
XffProto	boolean	任意	X-Forward-For-Proto ヘッダーを使用して、WAF がオリジンサーバーにリクエストを転送するために使用するプロトコルを識別するかどうかを指定します。有効な値は次のとおりです。 true (デフォルト): X-Forward-For-Proto ヘッダーを使用して、WAF が使用するプロトコルを識別します。 false: X-Forward-For-Proto ヘッダーを使用して、WAF が使用するプロトコルを識別しません。	false
BackupBackends	array	任意	オリジンサーバーのセカンダリ IP アドレスまたはドメイン名です。
	string	任意	オリジンサーバーのセカンダリ IP アドレスまたはドメイン名です。アドレスタイプは 1 つのみ使用できます。ドメイン名タイプを使用する場合、ドメイン名は 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	任意	オリジンへのトラフィックに対して HTTP/2 を有効にするかどうかを指定します。有効な値は次のとおりです。 true: オリジンへのトラフィックに対して HTTP/2 を有効にします。 false: オリジンへのトラフィックに対して HTTP/2 を無効にします。	true
Http2OriginMaxConcurrency	integer	任意	HTTP/2 オリジンへの同時リクエストの最大数です。有効な値: 1～512。デフォルト値: 128。	128
BackendPorts	array<object>	任意	カスタムポート構成です。
	object	任意	カスタムポート構成です。
ListenPort	integer	任意	リスナーポートです。	80
BackendPort	integer	任意	オリジンサーバーへの接続に使用するポートです。	80
Protocol	string	任意	リスナーポートのプロトコルです。有効な値は次のとおりです。 http: HTTP。 https: HTTPS。	http
ProxyProtocol	boolean	任意	クライアントの送信元 IP アドレスを保持するために Proxy Protocol 機能を有効にするかどうかを指定します。有効な値は次のとおりです。 true: Proxy Protocol 機能を有効にします。この機能を有効にすると、バックエンドサービスはクライアントの元の IP アドレスを表示できます。 false: Proxy Protocol 機能を無効にします。
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.

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

変更履歴

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