AssociateAnycastEipAddress - Anycast Elastic IP Address - Alibaba Cloud ドキュメントセンター

指定されたバックエンドのクラウドリソースにエニーキャスト EIP を関連付けます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eipanycast:AssociateAnycastEipAddress

create

*AnycastEipAddress

acs:eipanycast:{#regionId}:{#accountId}:anycast/{#anycastId}

LoadBalancer

acs:eipanycast:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Instance

acs:eipanycast:{#regionId}:{#accountId}:networkinterface/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BindInstanceId	string	必須	エニーキャスト EIP を関連付けるクラウドリソースの ID。	lb-d7oxbixhxv1uupnon****
BindInstanceRegionId	string	必須	クラウドリソースがデプロイされているリージョンの ID。エニーキャスト EIP は、特定のリージョンのクラウドリソースに関連付けることができます。`DescribeRegions` 操作を呼び出して、リージョン ID を照会できます。	us-west-1
BindInstanceType	string	必須	エニーキャスト EIP を関連付けるクラウドリソースのタイプ。有効な値： SlbInstance：Virtual Private Cloud (VPC) 内の Classic Load Balancer (CLB) インスタンス。 NetworkInterface：Elastic Network Interface (ENI)。	SlbInstance
AnycastId	string	必須	エニーキャスト EIP インスタンスの ID。	aeip-bp1ix34fralt4ykf3****
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないか確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false
PopLocations	array<object>	任意	クラウドリソースに関連付けられているアクセスエリアのアクセスポイントに関する情報。初めてクラウドリソースを関連付ける場合、このパラメーターを設定する必要はありません。システムは自動的にすべてのアクセスエリアを関連付けます。 `DescribeAnycastPopLocations` 操作を呼び出して、サポートされているアクセスエリアのアクセスポイントに関する情報を照会できます。
	object	任意	クラウドリソースに関連付けられているアクセスエリアのアクセスポイントに関する情報。初めてクラウドリソースを関連付ける場合、このパラメーターを設定する必要はありません。システムは自動的にすべてのアクセスエリアを関連付けます。 `DescribeAnycastPopLocations` 操作を呼び出して、サポートされているアクセスエリアのアクセスポイントに関する情報を照会できます。
PopLocation	string	任意	クラウドリソースに関連付けられているアクセスエリアのアクセスポイントに関する情報。初めてクラウドリソースを関連付ける場合、このパラメーターを設定する必要はありません。システムは自動的にすべてのアクセスエリアを関連付けます。 `DescribeAnycastPopLocations` 操作を呼び出して、サポートされているアクセスエリアのアクセスポイントに関する情報を照会できます。	us-west-1-pop
AssociationMode	string	任意	関連付けモード。有効な値： Default：デフォルトモード。このモードでは、関連付けられたクラウドリソースはデフォルトのオリジンサーバーです。 Normal：通常モード。このモードでは、関連付けられたクラウドリソースは通常のオリジンサーバーです。説明エニーキャスト EIP は複数のリージョンのクラウリソースに関連付けることができます。ただし、デフォルトのオリジンサーバーは 1 つだけ指定でき、通常のオリジンサーバーは複数指定できます。アクセスポイントを指定しない場合、または新しいアクセスポイントを追加する場合、リクエストはデフォルトでデフォルトのオリジンサーバーに転送されます。エニーキャスト EIP に初めてクラウドリソースを関連付ける場合、関連付けモードはデフォルトで Default になります。エニーキャスト EIP にクラウドリソースを関連付けるのが初めてでない場合は、関連付けモードを Default に設定できます。これにより、新しいクラウドリソースがデフォルトのオリジンサーバーになり、元のデフォルトのオリジンサーバーは通常のオリジンサーバーになります。	Default
PrivateIpAddress	string	任意	ENI のセカンダリプライベート IP アドレス。このパラメーターは、BindInstanceType が NetworkInterface に設定されている場合に必要です。このパラメーターを指定しない場合、ENI のプライマリプライベート IP アドレスが使用されます。	192.168.XX.XX

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	FBDB18D8-E91E-4978-8D6C-6E2E3EE10133

例

成功レスポンス

JSONJSON

{
  "RequestId": "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InstanceNotExist.ENI	Instance does not exist: The specified Elastic Network Interface (ENI) was not found. Please verify the instance ID or check if the resource has been released.
400	InstanceNotExist.SLB	Instance does not exist: The specified Server Load Balancer (SLB) was not found. Please verify the instance ID or check if the resource has been released.
400	IncorrectStatus.Anycast	The status of the Anycast instance is invalid.
400	OperationFailed.BindOnFreeNetworkInterface	Operation failed because the specified network interface is not bound on instance.
400	OperationFailed.Conflict	Operation failed: The request was too frequent or there was a concurrency conflict. Please try again later.
400	OperationUnsupported.BACKEND_REGION_NOT_OPEN	The specified Region is not supported.
400	OperationUnsupported.ServiceManaged	Operation is forbidden because this instance belongs to Service manager.
400	ResourceNotFound.BindInstanceId	Resource not found: The specified BindInstanceId does not exist.

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

変更履歴

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