ListOriginRules - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

複数のオリジンへの回帰ルール設定を照会します。

今すぐお試しください

この 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:ListOriginRules

list

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイトID。 ListSites オペレーションを呼び出してサイトIDを取得できます。	1234567890123
ConfigId	integer	任意	設定 ID。	35281609698****
ConfigType	string	任意	設定タイプ。このパラメータを使用して、グローバル設定またはルール設定を照会できます。有効な値： global：グローバル設定を照会します。 rule：ルール設定を照会します。このパラメータはオプションです。指定しない場合、グローバル設定とルール設定の両方が区別なく返されます。列挙値: rule : ルール設定 global : グローバル設定	global
RuleName	string	任意	ルール名。グローバル設定を追加する場合、このパラメータを設定する必要はありません。	test
PageNumber	integer	任意	ページネーション照会のページ番号。値は1 以上である必要があります。デフォルト値：1。	1
PageSize	integer	任意	ページネーション照会の1ページあたりのエントリ数。有効な値：1～500。デフォルト値：500。	20
SiteVersion	integer	任意	サイトのバージョン番号。バージョン管理が有効なサイトの場合、このパラメータを使用して設定が有効になるサイトバージョンを指定できます。デフォルト値：0。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ
RequestId	string	リクエストID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configs	array<object>	レスポンス内の設定。
	object
ConfigId	integer	設定 ID。	395386449776640
SiteVersion	integer	サイト設定のバージョン番号。設定バージョン管理が有効なサイトの場合、このパラメータを使用して設定が有効になるサイトバージョンを指定できます。デフォルト値：0。	1
Sequence	integer	ルールの実行順序。値が小さいほど優先度が高くなります。	1
RuleEnable	string	ルールスイッチ。グローバル設定を追加する場合、このパラメータを設定する必要はありません。有効な値： on：有効。 off：無効。	on
Rule	string	ルールの内容。条件式を使用してユーザーリクエストを照合します。グローバル設定を追加する場合、このパラメータを設定する必要はありません。使用シナリオは2つあります：すべての受信リクエストに一致させる：値をtrueに設定します。指定したリクエストに一致させる：カスタム式を設定します。例：(http.host eq "video.example.com")	(http.host eq \"video.example.com\")
RuleName	string	ルール名。グローバル設定を追加する場合、このパラメータを設定する必要はありません。	rule_example
ConfigType	string	設定タイプ。このパラメータに基づいて、グローバル設定またはルール設定を照会できます。有効な値： global：グローバル設定を照会します。 rule：ルール設定を照会します。	global
OriginHost	string	オリジンへの回帰リクエストで使用されるHOST。	origin.example.com
OriginScheme	string	オリジンへの回帰リクエストに使用されるプロトコル。有効な値： http：HTTPプロトコルを使用してオリジンに回帰します。 https：HTTPSプロトコルを使用してオリジンに回帰します。 follow：クライアントプロトコルに従ってオリジンに回帰します。	http
OriginSni	string	オリジンへの回帰リクエストで使用されるSNI。	origin.example.com
DnsRecord	string	オリジンへの回帰リクエストのために書き換えられたDNS 解決レコード。	test.example.com
OriginHttpPort	string	HTTPプロトコルを使用してオリジンに回帰する際にアクセスするオリジンサーバーポート。	8080
OriginHttpsPort	string	HTTPSプロトコルを使用してオリジンに回帰する際にアクセスするオリジンサーバーポート。	4433
Range	string	オリジンへの回帰ファイルダウンロードにレンジベースのスライスを使用します。有効な値： on：有効。 off：無効。 force：強制有効。	on
OriginMtls	string	mTLSスイッチ。有効な値： on：有効。 off：無効。	on
OriginVerify	string	オリジンサーバー証明書検証スイッチ。有効な値： on：有効。 off：無効。	on
RangeChunkSize	string	レンジチャンクサイズ。	1MB
OriginReadTimeout	string	オリジンサーバーの読み取りタイムアウト時間（秒単位）。	10
Follow302Enable	string	オリジンへの回帰時の302リダイレクトフォロースイッチ。有効な値： on：有効。 off：無効。	on
Follow302MaxTries	string	302リダイレクトフォローの最大回数。有効な値：1～5。	1
Follow302RetainArgs	string	元のリクエストパラメータを保持するスイッチ。有効な値： on：有効。 off：無効。	on
Follow302RetainHeader	string	元のリクエストヘッダーを保持するスイッチ。有効な値： on：有効。 off：無効。	on
Follow302TargetHost	string	302リダイレクト変更後のオリジンへの回帰ホスト。	test.com
PageNumber	integer	現在のページ番号。PageNumberリクエストパラメータと同じです。	1
PageSize	integer	ページサイズ。	10
TotalCount	integer	レコードの総数。	100
TotalPage	integer	総ページ数。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "OriginHost": "origin.example.com\n",
      "OriginScheme": "http",
      "OriginSni": "origin.example.com",
      "DnsRecord": "test.example.com\n",
      "OriginHttpPort": "8080",
      "OriginHttpsPort": "4433",
      "Range": "on",
      "OriginMtls": "on",
      "OriginVerify": "on",
      "RangeChunkSize": "1MB",
      "OriginReadTimeout": "10",
      "Follow302Enable": "on",
      "Follow302MaxTries": "1",
      "Follow302RetainArgs": "on",
      "Follow302RetainHeader": "on",
      "Follow302TargetHost": "test.com"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "TotalPage": 2
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.

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

変更履歴

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