UpdateRedirectRule API による ESA リダイレクトルールのプログラム管理 - ESA

サイトの自動転送設定を更新します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイトの ID です。この ID を取得するには、ListSites 操作を呼び出します。	123456****
ConfigId	integer	必須	構成の ID です。この ID を取得するには、ListRedirectRules 操作を呼び出します。	3528160969****
RuleName	string	任意	ルールの名前です。グローバル構成では、このパラメーターは必須ではありません。	rule_example
RuleEnable	string	任意	ルールを有効化するかどうかを指定します。グローバル構成では、このパラメーターは必須ではありません。有効な値は以下のとおりです。 `on`：ルールを有効化します。 `off`：ルールを無効化します。	on
Rule	string	任意	ユーザーのリクエストに一致する条件式です。グローバル構成では、このパラメーターは必須ではありません。以下の 2 つのシナリオがサポートされています。すべてのリクエストに一致させる場合は、値を `true` に設定します。特定のリクエストに一致させる場合は、カスタム式（例：`(http.host eq "video.example.com")`）を使用します。	(http.host eq "video.example.com")
Type	string	任意	自動転送のタイプです。有効な値は以下のとおりです。 `static`：静的モード `dynamic`：動的モード列挙値: static : dynamic :	static
TargetUrl	string	任意	リクエストを転送先とする URL です。	http://www.exapmle.com/index.html
StatusCode	string	任意	エッジノードがクライアントに返すリダイレクト応答の状態コードです。有効な値は以下のとおりです。 301 302 303 307 308	301
ReserveQueryString	string	任意	元のリクエストのクエリ文字列を保持するかどうかを指定します。有効な値は以下のとおりです。 `on`：クエリ文字列を保持します。 `off`：クエリ文字列を保持しません。	on
Sequence	integer	任意	ルールの実行順序です。数値が小さいほど優先度が高くなります。	1

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクトです。
RequestId	string	リクエストの ID です。	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE

例

成功レスポンス

JSONJSON

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ApplyVipError	Failed to apply for ip resources, please contact customer service.
400	CanNotSetSequence	Non-regular configuration, you cannot set Sequence parameters.
400	CacheReserveSiteExceedLimit	The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit.
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	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	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	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.
400	SpecifiedVersionReadOnly	The specified version number is read-only and cannot be modified.
400	VersionNotValid	The site does not have version management enabled, or the version number passed in does not exist.
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	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
400	InvalidParameter.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.
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	IllegalOperation.VersionManagement	The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400	QuotaCheckFailed.VersionManagement	Insufficient quota for version management. Contact technical support.
400	InvalidConfigId	The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	CachceReserveInstanceCheckFalied	If the site uses the back-to-source whitelist node and the cache holding instance is not in the back-to-source whitelist, the cache holding instance cannot be associated with the site. If you want to use both functions at the same time, please contact customer service for details.
400	VerifyExpressionError	Dynamic expression is invalid.
400	QuotaCheckFailed.FunctionArg	The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your 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	MissingParameter	The specified ArgName is required for this function.
400	FunctionArgError	Failed to check the configured function parameters.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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