ListRedirectRules API によるリダイレクトルールのリストとフィルタリング - ESA

リダイレクトルールリストの照会

今すぐお試しください

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

none

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。これは、ListSites インターフェイスを呼び出すことで取得できます。	123456******
ConfigId	integer	任意	構成 ID。	35281609698****
ConfigType	string	任意	構成タイプ。指定可能な値は次のとおりです。 global: グローバル構成。 rule: ルール構成。	rule
RuleName	string	任意	ルール名。指定された名前のルールを見つけるために使用できます。	rule_example
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	ページサイズ。デフォルトは 500 で、有効値の範囲は 1～500 です。	20
SiteVersion	integer	任意	サイト構成のバージョン番号。バージョン管理が有効なサイトの場合、このパラメーターを使用してサイト構成の有効なバージョンを指定できます。デフォルトはバージョン 0 です。	0

レスポンスフィールド

フィールド	型	説明	例
	object	リクエスト応答結果。
RequestId	string	リクエスト ID。	EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
Configs	array<object>	リダイレクト構成のリスト。
	object	リダイレクト構成の詳細。
ConfigId	integer	構成 ID。	35281609698****
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: ルール構成。	rule
Type	string	リダイレクトタイプ。指定可能な値は次のとおりです。 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
PageNumber	integer	現在のページ番号。	1
PageSize	integer	ページサイズ。	20
TotalCount	integer	アイテムの総数。	10
TotalPage	integer	総ページ数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
  "Configs": [
    {
      "ConfigId": 0,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleName": "rule_example",
      "ConfigType": "rule",
      "Type": "static",
      "TargetUrl": "http://www.exapmle.com/index.html\n",
      "StatusCode": "301",
      "ReserveQueryString": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 10,
  "TotalPage": 1
}

エラーコード

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.

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

変更履歴

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