ListSiteRoutes - 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:ListSiteRoutes

none

*サイト。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。 ListSites 操作を呼び出して取得できます。	123456****
ConfigId	integer	任意	構成 ID。	35281609698****
ConfigType	string	任意	構成タイプ。このパラメーターを使用してグローバル構成または特徴構成をクエリできます。このパラメーターは functionName が指定されている場合にのみ効果があります。列挙値: rule : ルール構成。 global : グローバル構成。	global
RouteName	string	任意	ルート名。このパラメーターを使用して、指定された値に一致する名前のルールをクエリできます。このパラメーターは functionName が指定されている場合にのみ効果があります。	test_route
PageNumber	integer	任意	ページングクエリのページ番号。値は 1 以上である必要があります。	1
PageSize	integer	任意	ページングクエリのページあたりのエントリ数。有効な値: 1～500。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
Configs	array<object>	応答の構成リスト。
	object
ConfigId	integer	構成 ID。	35281609698****
SiteVersion	integer	サイトのバージョン番号。	1
Sequence	integer	ルールの実行順序。	1
RouteEnable	string	ルートスイッチ。有効な値: on: 有効。 off: 無効。	on
Rule	string	ルールの内容。	(http.host eq \"video.example.com\")
RouteName	string	ルート名。	test_route
ConfigType	string	構成タイプ。このパラメーターを使用してグローバル構成またはルール構成をクエリできます。有効な値: global: グローバル構成をクエリします。 rule: ルール構成をクエリします。	global
RoutineName	string	エッジルーチン名。	test-routine1
Bypass	string	バイパスモード。有効な値: on: 有効。 off: 無効。	on
Mode	string	構成モード。有効な値: simple: シンプルモード。 custom: カスタムモード。	simple
Fallback	string	CDN フォールバック。有効な値: on: 有効。 off: 無効。	on
Timeout	string	エッジルーチンのタイムアウト期間（秒単位）。	60
PageNumber	integer	現在のページ番号。PageNumber リクエストパラメーターと同じです。	1
PageSize	integer	ページあたりのエントリ数。	10
TotalCount	integer	レコードの総数。	16
TotalPage	integer	ページの総数。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
  "Configs": [
    {
      "ConfigId": 0,
      "SiteVersion": 1,
      "Sequence": 1,
      "RouteEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")",
      "RouteName": "test_route",
      "ConfigType": "global",
      "RoutineName": "test-routine1",
      "Bypass": "on",
      "Mode": "simple",
      "Fallback": "on",
      "Timeout": "60"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "TotalPage": 10
}

エラーコード

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.

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

変更履歴

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