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

list

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。デフォルト値： 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。正の整数である必要があります。最大値は 500 です。500 を超える値は自動的に 500 に設定されます。	20
Name	string	任意	オリジンプールの名前。	pool1
MatchType	string	任意	オリジンプール名のクエリタイプ。デフォルト値： exact。有効な値： `fuzzy` ：あいまい一致。 `exact` ：完全一致。	exact
OrderBy	string	任意	オリジンプール ID に基づくソート順。ID は作成時刻が新しいほど大きくなります。 `id` ：降順 (デフォルト)。 `id_asc` ：昇順。	id
SiteId	integer	必須	サイト ID。この ID は `ListSites` API を呼び出して取得できます。	151538882642832

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
RequestId	string	リクエスト ID。	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	オリジンプールの一覧。
	array<object>	オリジンプールの詳細。
Id	integer	オリジンプールの ID。	1038520525196928
Name	string	オリジンプールの名前。サイト内で一意である必要があります。	pool1
SiteId	integer	オリジンプールが属するサイトの ID。	216558609793952
RecordName	string	オリジンプールに割り当てられたドメイン名。サイト内のレコードのオリジンアドレスとして使用されます。	pool1.example.com
Enabled	boolean	オリジンプールが有効かどうかを示します。 `true` ：有効。 `false` ：無効。	false
References	object	このオリジンプールを参照しているリソース。ロードバランサーまたはレコードがオリジンとしてこのプールを使用する場合、参照されていると見なされます。
LoadBalancers	array<object>	このオリジンプールを使用するロードバランサー。
	object	このオリジンプールを使用するロードバランサー。
Name	string	ロードバランサーの名前。	lb1.example.com
Id	integer	ロードバランサーの ID。	998740660522624
DnsRecords	array<object>	このオリジンプールをオリジンとして使用するレイヤー 7 レコード。
	object	このオリジンプールをオリジンとして使用するレイヤー 7 レコード。
Name	string	レコードの名前。	www.example.com
Id	integer	レコードの ID。	1042852886352704
IPARecords	array<object>	このオリジンプールをオリジンとして使用するレイヤー 4 レコード。
	object	このオリジンプールをオリジンとして使用するレイヤー 4 レコード。
Name	string	レコードの名前。	ipa.example.com
Id	integer	レコードの ID。	1042852886352704
ReferenceLBCount	integer	このオリジンプールを参照しているロードバランサーの数。	5
Origins	array<object>	プール内のオリジン。
	array<object>	プール内のオリジンの詳細。
Id	integer	オリジンの ID。	997502094872132
Name	string	オリジンの名前。	origin1
Address	string	オリジンのアドレス (`www.example.com` など) 。	www.example.com
Enabled	boolean	オリジンが有効かどうかを示します。 `true` ：有効。 `false` ：無効。	true
Weight	integer	オリジンの重み。有効な値は 0～100 です。	50
Type	string	オリジンタイプ。有効な値は次のとおりです： `ip_domain` ：IP アドレスまたはドメイン名。 `OSS` ：OSS バケット。 `S3` ：AWS S3 バケット。	S3
Header	any	オリジンリクエストとともに送信されるリクエストヘッダー。 `Host` ヘッダーのみがサポートされています。	{ "Host": [ "example.com" ] }
AuthConf	object	オリジンの認証設定。オリジン (OSS バケットや AWS S3 バケットなど) で認証が必要な場合は必須です。
AuthType	string	認証タイプ。有効な値は次のとおりです： `public` ：パブリックアクセス可能な OSS または AWS S3 バケット。 `private_same_account` ：同一アカウント内の OSS オリジンへのプライベート認証。 `private_cross_account` ：OSS オリジンへのクロスアカウントのプライベート認証。 `private` ：AWS S3 オリジンへのプライベート認証。	public
AccessKey	string	プライベート認証用の AccessKey。	yourAccessKeyID
SecretKey	string	プライベート認証用の SecretKey。	yourAccessKeySecret
Version	string	AWS S3 バケットオリジンの署名バージョン。	v2
Region	string	オリジンリージョン。AWS S3 バケットオリジンの場合は必須です。	us-east-1
IpVersionPolicy	string	オリジンリクエストの IP バージョンポリシー。有効な値は次のとおりです： `round_robin` ：IPv4 と IPv6 を交互に使用 (デフォルト)。 `ipv4_first` ：IPv4 を優先。 `ipv6_first` ：IPv6 を優先。 `follow` ：クライアントリクエストの IP バージョンと一致。	round_robin
PageNumber	integer	現在のページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	20
TotalCount	integer	オリジンプールの総数。	16
TotalPage	integer	総ページ数。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "OriginPools": [
    {
      "Id": 1038520525196928,
      "Name": "pool1",
      "SiteId": 216558609793952,
      "RecordName": "pool1.example.com\n",
      "Enabled": false,
      "References": {
        "LoadBalancers": [
          {
            "Name": "lb1.example.com\n",
            "Id": 998740660522624
          }
        ],
        "DnsRecords": [
          {
            "Name": "www.example.com\n",
            "Id": 1042852886352704
          }
        ],
        "IPARecords": [
          {
            "Name": "ipa.example.com\n",
            "Id": 1042852886352704
          }
        ]
      },
      "ReferenceLBCount": 5,
      "Origins": [
        {
          "Id": 997502094872132,
          "Name": "origin1",
          "Address": "www.example.com",
          "Enabled": true,
          "Weight": 50,
          "Type": "S3",
          "Header": "{\n        \"Host\": [\n          \"example.com\"\n        ]\n      }",
          "AuthConf": {
            "AuthType": "public",
            "AccessKey": "yourAccessKeyID",
            "SecretKey": "yourAccessKeySecret",
            "Version": "v2",
            "Region": "us-east-1\n"
          },
          "IpVersionPolicy": "round_robin"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 16,
  "TotalPage": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.Coverage	The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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