CreateOriginPool API でマルチオリジンルーティングのオリジンプールを構成 - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

サイトのオリジンプールを作成します。作成したオリジンプールは、Server Load Balancer (SLB) で使用したり、直接のバックツーオリジンリクエストに使用したりできます。

操作説明

オリジンプールには、ドメイン名、IP、OSS、S3 などの複数のオリジンを追加できます。OSS および S3 オリジンでは、オリジン認証を利用できます。

今すぐお試しください

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

create

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	オリジンプールの名前。サイト内で一意である必要があります。	pool1
Enabled	boolean	任意	オリジンプールが有効かどうかを指定します。 `true`：有効 `false`：無効	true
Origins	array<object>	任意	オリジンプールに追加するオリジンのリスト。配列を使用して複数のオリジンを指定します。
	array<object>	任意	単一のオリジンの設定。
Name	string	任意	オリジンの名前。オリジンプール内で一意である必要があります。	origin1
Address	string	任意	オリジンのアドレス。例： www.example.com。	www.example.com
Enabled	boolean	任意	オリジンが有効かどうかを指定します。 `true`：有効 `false`：無効	true
Header	any	任意	オリジンフェッチに含めるリクエストヘッダー。`Host` ヘッダーのみサポートされています。	{ "Host": [ "example.com" ] }
Weight	integer	任意	オリジンの加重。0 ~ 100 の整数である必要があります。	50
Type	string	任意	オリジンのタイプ。有効な値は次のとおりです。 `ip_domain`： IP アドレスまたはドメイン名。 `OSS`： Alibaba Cloud OSS バケット。 `S3`： AWS S3 バケット。	ip_domain
AuthConf	object	任意	オリジンの認証設定。認証が必要な OSS または AWS S3 バケットの場合に必要です。
AuthType	string	任意	認証タイプ。有効な値は次のとおりです。 `public`：パブリック読み取り/書き込み。パブリック OSS または AWS S3 バケットに使用します。 `private_same_account`：同じ Alibaba Cloud アカウント内の OSS バケットに対するプライベート認証。 `private_cross_account`：異なる Alibaba Cloud アカウント内の OSS バケットに対するプライベート認証。 `private`： AWS S3 バケットに対するプライベート認証。	public
AccessKey	string	任意	プライベート認証に必要なアクセスキー。	yourAccessKeyID
SecretKey	string	任意	プライベート認証に必要なシークレットキー。	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
SiteId	integer	必須	サイト ID。この ID を取得するには、ListSites オペレーションを呼び出します。	21655860979****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ
RequestId	string	リクエスト ID。	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
Id	integer	オリジンプールの ID。	103852052519****

例

成功レスポンス

JSONJSON

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\n",
  "Id": 0
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	The specified parameter is invalid.
400	SourceNumberExceedLimit	The number of sources in the origin pool exceeds the quota limit.
400	PoolNumberExceedQuotaLimit	The number of origin pool you have added has reached the upper limit of the plan quota. Please delete the origin pool that is no longer in use or upgrade the plan and try again.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.AddressConflict	Duplicate origin addresses. Make sure that each origin address for the same pool is unique.
400	OriginPoolNameConflict	The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.
400	SourceAddressInvalid	Invalid origin address. Check whether the IP address or domain name is in the valid format.
400	SourceCircleExist	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.
400	SourceInBlackList	The source is in the black list.
400	InvalidParameter.PrivateIpAsSourceUnsupported	The provided origin is an invalid private IP address. Please verify and resubmit.
400	InvalidParameter.SourceIpInBlacklist	The provided origin is an invalid private IP address. Please verify and resubmit.
400	OriginPool.TypeNotSupport	The origin address pool type is not supported.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.
404	SiteNotFound	The website does not exist or does not belong to you.

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

変更履歴

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