サイト向けのオリジンリクエストルールを作成します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SiteId |
integer |
必須 |
サイトの ID です。この ID は、ListSites 操作を呼び出すことで取得できます。 |
340035003106221 |
| SiteVersion |
integer |
任意 |
バージョン管理が有効化されたサイトの場合、このパラメーターで構成を適用するバージョンを指定します。デフォルト値は 0 です。 |
1 |
| RuleName |
string |
任意 |
ルール名です。グローバル構成を作成する際には必須ではありません。 |
rule_example |
| RuleEnable |
string |
任意 |
ルールを有効化するかどうかを指定します。グローバル構成を作成する際には必須ではありません。有効な値は以下のとおりです。
|
on |
| Rule |
string |
任意 |
ルールの内容です。これは、ユーザーのリクエストにマッチする条件式(Conditional Expression)です。グローバル構成を作成する際には必須ではありません。以下の 2 つのシナリオがあります。
|
(http.host eq \"video.example.com\") |
| OriginHost |
string |
任意 |
オリジンリクエストで使用する |
origin.example.com |
| OriginScheme |
string |
任意 |
オリジンリクエストで使用するプロトコルです。有効な値は以下のとおりです。
|
http |
| OriginSni |
string |
任意 |
オリジンリクエストで使用するサーバ名表示(Server Name Indication: SNI)です。 |
origin.example.com |
| DnsRecord |
string |
任意 |
オリジンリクエストの DNS レコードを上書きします。 |
test.example.com |
| OriginHttpPort |
string |
任意 |
HTTP オリジンリクエストで使用するオリジンポートです。 |
8080 |
| OriginHttpsPort |
string |
任意 |
HTTPS オリジンリクエストで使用するオリジンポートです。 |
4433 |
| Range |
string |
任意 |
オリジンからのファイルダウンロードに範囲リクエスト(range requests)を使用するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| OriginMtls |
string |
任意 |
オリジン接続に対して相互 Transport Layer Security(mTLS)を有効化するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| OriginVerify |
string |
任意 |
オリジン証明書検証を有効化するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| RangeChunkSize |
string |
任意 |
範囲リクエストにおける各チャンクのサイズです。有効な値は以下のとおりです。
|
1MB |
| Sequence |
integer |
任意 |
ルールの優先度です。数値が小さいほど優先度が高くなります。 |
1 |
| OriginReadTimeout |
string |
任意 |
オリジン読み取りタイムアウト(秒単位)です。 |
10 |
| Follow302Enable |
string |
任意 |
オリジンからの 302 リダイレクトを追跡するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| Follow302MaxTries |
string |
任意 |
追跡する 302 リダイレクトの最大回数です。有効な範囲は 1~5 です。 |
1 |
| Follow302RetainArgs |
string |
任意 |
302 リダイレクトを追跡する際に、元のリクエストパラメーターを保持するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| Follow302RetainHeader |
string |
任意 |
302 リダイレクトを追跡する際に、元のリクエストヘッダーを保持するかどうかを指定します。有効な値は以下のとおりです。
|
on |
| Follow302TargetHost |
string |
任意 |
302 リダイレクト後に使用するオリジン |
test.com |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクトです。 |
||
| RequestId |
string |
リクエストの ID です。 |
04F0F334-1335-436C-A1D7-6C044FE73368 |
| ConfigId |
integer |
構成の ID です。 |
352816096987136 |
例
成功レスポンス
JSONJSON
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"ConfigId": 352816096987136
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | MissingParameter | The specified ArgName is required for this function. | |
| 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 | 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 | 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 | 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. | |
| 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 | FunctionArgError | Failed to check the configured function parameters. | |
| 404 | SiteNotFound | The website does not exist or does not belong to you. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。