API によるウェイティングルームルールのトラフィック制御 - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

ウェイティングルームバイパスルールを作成します。

操作説明

この特徴を使用するには、サイトプランが Enterprise Edition 以上であり、サイトプランがこの特徴をサポートしている必要があります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:CreateWaitingRoomRule

create

*サイト。

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。 ListSites 操作を呼び出してサイト ID を取得できます。	123456****
WaitingRoomId	string	必須	バイパスするウェイティングルームの ID。	25133f536f1b1f6b6091f6a92c614dd4
RuleName	string	必須	ルール名。グローバル構成を追加する場合、このパラメーターは必須ではありません。	waitingroom_example
RuleEnable	string	必須	ルールを有効にするかどうかを指定します。グローバル構成を追加する場合、このパラメーターは必須ではありません。有効な値: on: 有効。 off: 無効。	on
Rule	string	必須	ルールの内容。条件式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターは必須ではありません。2 つのシナリオがサポートされています: すべての受信リクエストに一致: 値を true に設定します。指定されたリクエストに一致: 値をカスタム式に設定します。例: (http.host eq "video.example.com")。ルール式の完全な構文については、https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/ を参照してください。	(http.request.uri.path.file_name eq \"jpg\")

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
WaitingRoomRuleId	integer	ウェイティングルームバイパスルールの ID。	420072638347264

例

成功レスポンス

JSONJSON

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "WaitingRoomRuleId": 420072638347264
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	The specified ArgName is required for this function.
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.
400	ConfExceedLimit	The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	LockFailed	The system is handling requests you previously submitted. Try again later.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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