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

送信元アドレスプール ID に基づいて、特定の送信元アドレスプールを取得します。

今すぐお試しください

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

get

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	オリジンプール ID。取得するには、ListOriginPools を呼び出します。	1038520525196928
SiteId	integer	必須	サイト ID。取得するには、ListSites を呼び出します。	216558609793952

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
Id	integer	オリジンプール ID。	103852052519****
Name	string	オリジンプールの名称。名称はサイト内で一意である必要があります。	pool1
SiteId	integer	オリジンプールを含むサイトの ID。	21655860979****
RecordName	string	オリジンプールに割り当てられたドメイン名。サイト内のレコードのオリジンアドレスとして機能します。	pool1.example.com
Enabled	boolean	オリジンプールが有効かどうかを示します。 true：オリジンプールは有効です。 false：オリジンプールは無効です。	true
References	object	オリジンプールを参照するリソース。ロードバランサーまたはレコードがオリジンとしてこのオリジンプールを使用する場合、参照されていることになります。
LoadBalancers	array<object>	このオリジンプールを使用するロードバランサー。
	object	このオリジンプールを使用する単一のロードバランサー。
Name	string	ロードバランサーの名称。	lb1.example.com
Id	integer	ロードバランサーの ID。	99874066052****
DnsRecords	array<object>	このオリジンプールをオリジンとして使用するレイヤー 7 レコード。
	object	このオリジンプールをオリジンとして使用する単一のレイヤー 7 レコード。
Name	string	レコードの名称。	www.example.com
Id	integer	レコードの ID。	104285288635****
IPARecords	array<object>	このオリジンプールをオリジンとして使用するレイヤー 4 レコード。
	object	このオリジンプールをオリジンとして使用する単一のレイヤー 4 レコード。
Name	string	レコードの名称。	ipa.example.com
Id	integer	レコードの ID。	104285288635****
ReferenceLBCount	integer	このオリジンプールを参照するロードバランサーの数。	5
Origins	array<object>	オリジンプール内のオリジン。
	array<object>	オリジンプール内の単一のオリジン。
Id	integer	オリジン ID。	99750209487****
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 バケット。	ip_domain
Header	any	オリジンリクエストに含めるリクエストヘッダー。Host ヘッダーのみをサポートします。	{ "Host": [ "example.com" ] }
AuthConf	object	認証設定。オリジンが認証を必要とする OSS バケットまたは S3 バケットである場合、このパラメーターは必須です。
AuthType	string	認証タイプ。 public：パブリックアクセス。パブリック読み取りアクセスを持つ OSS または S3 オリジン用。 private_same_account：プライベート、同一アカウント。同一アカウント内のプライベート OSS オリジン用。 private_cross_account：プライベート、クロスアカウント。別のアカウントのプライベート OSS オリジン用。 private：プライベート。プライベート S3 オリジン用。	public
AccessKey	string	AccessKey ID。 `AuthType` が `private_cross_account` または `private` に設定されている場合、このパラメーターは必須です。	yourAccessKeyID
SecretKey	string	AccessKey シークレット。 `AuthType` が `private_cross_account` または `private` に設定されている場合、このパラメーターは必須です。	yourAccessKeySecret
Version	string	署名バージョン。オリジンが AWS S3 バケットの場合に必要です。	v4
Region	string	オリジンの AWS リージョン。オリジンが AWS S3 バケットの場合に必要です。	us-east-1
IpVersionPolicy	string	オリジンリクエストの IP バージョンポリシー。 round_robin：デフォルトのポリシー。リクエストを IPv4 と IPv6 のオリジンにラウンドロビン方式でルーティングします。 ipv4_first：IPv4 を優先します。リクエストを最初に IPv4 オリジンにルーティングします。 ipv6_first：IPv6 を優先します。リクエストを最初に IPv6 オリジンにルーティングします。 follow：クライアントの IP バージョンに一致させます。オリジンリクエストは、受信リクエストと同じ IP バージョンを使用します。	round_robin

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Id": 0,
  "Name": "pool1",
  "SiteId": 0,
  "RecordName": "pool1.example.com",
  "Enabled": true,
  "References": {
    "LoadBalancers": [
      {
        "Name": "lb1.example.com",
        "Id": 0
      }
    ],
    "DnsRecords": [
      {
        "Name": "www.example.com",
        "Id": 0
      }
    ],
    "IPARecords": [
      {
        "Name": "ipa.example.com",
        "Id": 0
      }
    ]
  },
  "ReferenceLBCount": 5,
  "Origins": [
    {
      "Id": 0,
      "Name": "origin1",
      "Address": "www.example.com",
      "Enabled": true,
      "Weight": 50,
      "Type": "ip_domain",
      "Header": "{\n        \"Host\": [\n          \"example.com\"\n        ]\n      }",
      "AuthConf": {
        "AuthType": "public",
        "AccessKey": "yourAccessKeyID",
        "SecretKey": "yourAccessKeySecret",
        "Version": "v4",
        "Region": "us-east-1\n"
      },
      "IpVersionPolicy": "round_robin"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	OriginPoolNotExist	The specified origin pool does not exist or does not belong to your account or website. Check and try again.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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