elastic IPアドレス (EIP) を同じリージョンのインスタンスに関連付けます。

使用上の注意

  • EIPを、同じリージョン内のElastic Compute Service (ECS) インスタンス、Classic Load Balancer (CLB) インスタンス、セカンダリelastic network interface (ENI) 、NATゲートウェイ、または高可用性仮想IPアドレス (HAVIP) に関連付けることができます。 ECSインスタンスとCLBインスタンスは、仮想プライベートクラウド (VPC) にデプロイする必要があります。
  • AssociateEipAddress操作は非同期です。 リクエストを送信すると、システムはリクエストIDを返します。 ただし、操作はまだシステムバックグラウンドで実行されています。 DescribeEipAddressesを呼び出して、EIPのステータスを照会できます。
    • EIPがAssociating状態の場合、EIPは関連付けられています。 この状態では、EIPのみを照会でき、他の操作は実行できません。
    • EIPがInUse状態の場合、EIPは関連付けられています。
  • AssociateEipAddressを繰り返し呼び出して、指定された期間内にEIPをインスタンスに関連付けることはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明
操作 String 必須 AssociateEipAddress

実行する操作です。 値をAssociateEipAddressに設定します。

RegionId String 必須 cn-hangzhou

インスタンスが属するリージョンの ID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

AllocationId String 必須 eip-2zeerraiwb7ujsxdc ****

インスタンスに関連付けるEIPのID。

InstanceId String 必須 i-2zebb08phyczzawe ****

EIPを関連付けるインスタンスのID。

NATゲートウェイ、CLBインスタンス、ECSインスタンス、セカンダリENI、またはHAVIPのIDを入力できます。

InstanceType String 任意 EcsInstance

EIPを関連付けるインスタンスのタイプ。 有効な値：

  • Nat: NATゲートウェイ
  • SlbInstance: CLBインスタンス
  • EcsInstance (デフォルト): VPC内のECSインスタンス
  • NetworkInterface: セカンダリENI
  • HaVip: HAVIP
説明 このパラメーターを設定しない場合、EIPに関連付けられるインスタンスのタイプはEcsInstanceです。 EIPを関連付けるインスタンスのタイプがEcsInstanceでない場合、このパラメーターは必須です。
InstanceRegionId String 任意 cn-hangzhou

EIPを関連付けるインスタンスのリージョンID。

説明 このパラメーターは、EIPが共有帯域幅Global Accelerator (GA) インスタンスに関連付けられている場合にのみ必要です。
PrivateIpAddress String 任意 192.168.XX.XX

vSwitchのCIDRブロック内のIPアドレス。

このパラメーターを設定しない場合、システムはVPC IDとvSwitch IDに基づいてプライベートIPアドレスを割り当てます。

モード String 任意 NAT

関連付けモード。 有効な値：

  • NAT (デフォルト): NATモード
  • MULTI_BINDED: マルチEIP-to-ENIモード
  • BINDED: カットスルーモード

このパラメーターは、InstanceTypeがNetworkInterfaceに設定されている場合にのみ必要です。

ClientToken String 任意 0c593ea1-3bea-11e9-b96b-88e9fe63 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、値が異なるリクエスト間で一意であることを確認する必要があります。 ClientToken値にはASCII文字のみを使用でき、長さは64文字を超えることはできません。

レスポンスパラメーター

項目 データ型 例: 説明
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=AssociateEipAddress
&RegionId=cn-hangzhou
&AllocationId=eip-2zeerraiwb7ujsxdc ****
&InstanceId=i-2zebb08phyczzawe ****
&InstanceType=EcsInstance
&InstanceRegionId=cn-hangzhou
&PrivateIpAddress=192.168.XX.XX
&モード=NAT
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63 ****
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AssociateEipAddressResponse>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</AssociateEipAddressResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidAssociation.Duplicated 指定されたインスタンスは既に関連付けられています。 EIPインスタンスまたはGAインスタンスが指定されたインスタンスに既に関連付けられている場合に返されるエラーメッセージ。 操作を実行する前に、指定されたインスタンスからEIPまたはGAインスタンスの関連付けを解除する必要があります。
400 OperationDenied 指定されたインスタンスは VPC にありません。 指定されたインスタンスがVPCに存在しない場合に返されるエラーメッセージ。
400 InvalidParameter.Mismatch 指定された Elastic IP アドレスと ECS インスタンスは同じリージョンにありません。 指定されたEIPインスタンスとECSインスタンスが同じリージョンに属していない場合に返されるエラーメッセージ。
400 IncorrectEipStatus 現在のelastic IPステータスはこの操作をサポートしていません EIPのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
400 IncorrectInstanceStatus 現在のインスタンスのステータスでは、この操作を実行できません。 インスタンスが現在の状態ではこの操作を実行できない場合に返されるエラーメッセージ。
400 InvalidInstanceType.ValueNotSupported InstanceType に指定された値はサポートされていません。 InstanceTypeが無効な値に設定されている場合に返されるエラーメッセージ。
400 InvalidParameter 指定されたパラメータは無効です。 パラメーターが無効な値に設定されている場合に返されるエラーメッセージ。
400 OperationDenied デフォルト vpc の EIP では、この操作を実行できません 操作がデフォルトVPCのEIPでサポートされていない場合に返されるエラーメッセージ。
400 Forbbiden eipインスタンスowenerエラー EIPで操作を実行する権限がない場合に返されるエラーメッセージ。
400 InvalidBindingStatus eipバインディングステータスが無効です。 EIPが無効な状態の場合に返されるエラーメッセージ。
400 BIND_INSTANCE_HAVE_PORTMAP_OR_BIND_EIP インスタンスは、portMapまたは既にバインドeipを有することができる。 ECSインスタンスにポート転送ルールが設定されている場合に返されるエラーメッセージ。 ポート転送ルールを削除して、もう一度お試しください。
400 BIND_INSTANCE_OWENER_ERROR eipを操作できません。 指定されたEIPを管理する権限がない場合に返されるエラーメッセージ。
400 InvalidParams.NotFound インスタンス非検出 指定されたインスタンスが存在しない場合に返されるエラーメッセージ。
400 OperationDenied.CloudBoxResourceExist VPCにクラウドボックスに関連するリソースがあるため、操作は許可されません。 VPCにCloudBox関連のリソースが含まれており、操作が許可されていない場合に返されるエラーメッセージ。
400 OperationDenied.CloudBoxVSwitchExist クラウドボックスタイプのvSwitchがVPCに存在するため、操作は許可されません。 VPCにCloudBoxタイプのvSwitchが含まれており、操作が許可されていない場合に返されるエラーメッセージ。
404 InvalidInstanId.NotFound 指定されたインスタンスは存在しません。 指定されたインスタンスが存在しない場合に返されるエラーメッセージ。 インスタンスIDが有効かどうかを確認します。
404 InvalidAllocationId.NotFound 指定された割り当て ID が見つかりません 指定されたEIPが存在しない場合に返されるエラーメッセージ。 指定された値が有効かどうかを確認します。
503 ServiceUnavailable サーバーの一時的な障害により、リクエストは失敗しました。 サーバーの一時的な誤動作によりリクエストが失敗した場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。