調用AssociateEipAddress將彈性公網(wǎng)IP（EIP）綁定到同地域的云產(chǎn)品實例上。
接口說明
-
EIP 實例可綁定到同地域的專有網(wǎng)絡類型的 ECS 實例、專有網(wǎng)絡類型的 CLB 實例、輔助彈性網(wǎng)卡、NAT 網(wǎng)關和高可用虛擬 IP 上。
-
AssociateEipAddress 接口屬于異步接口，即系統(tǒng)會先返回一個請求 ID，但 EIP 實例與云產(chǎn)品實例并未綁定完成，系統(tǒng)后臺的綁定任務仍在進行。您可以調用 DescribeEipAddresses 查詢 EIP 實例的狀態(tài)：
- 當 EIP 實例處于 Associating 狀態(tài)時，表示 EIP 實例正在綁定中，在該狀態(tài)下，您只能執(zhí)行查詢操作，不能執(zhí)行其他操作。
- 當 EIP 實例處于 InUse 狀態(tài)時，表示 EIP 實例綁定完成。
-
AssociateEipAddress 接口不支持同一個 EIP 實例并發(fā)綁定云產(chǎn)品實例。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| vpc:AssociateEipAddress | update | *Address acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}*NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}*Instance acs:vpc:{#regionId}:{#accountId}:instance/{#InstanceId}*Association acs:vpc:{#regionId}:{#accountId}:havip/{#HaVipId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要綁定云產(chǎn)品實例的 EIP 所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| AllocationId | string | 是 | 綁定云產(chǎn)品實例的 EIP 的 ID。 | eip-2zeerraiwb7ujsxdc**** |
| InstanceId | string | 是 | 要綁定 EIP 的實例 ID。 支持輸入 NAT 網(wǎng)關實例 ID、傳統(tǒng)型負載均衡 CLB 實例 ID、云服務器 ECS 實例 ID、輔助彈性網(wǎng)卡實例 ID、高可用虛擬 IP 實例 ID、IP 地址。 | i-2zebb08phyczzawe**** |
| InstanceType | string | 否 | 要綁定 EIP 的實例的類型，取值：
說明
默認要綁定 EIP 的實例類型為 EcsInstance，如果您需要綁定 EIP 的實例類型不為 EcsInstance，則該值必填。
| EcsInstance |
| InstanceRegionId | string | 否 | 要綁定 EIP 的實例所屬地域的 ID。 說明
僅在 EIP 加入到帶寬共享型全球加速實例后，才需要填寫該參數(shù)。
| cn-hangzhou |
| PrivateIpAddress | string | 否 | 交換機網(wǎng)段內的一個 IP 地址。 如果不輸入該參數(shù)，系統(tǒng)根據(jù) VPC ID 和交換機 ID 自動分配一個私網(wǎng) IP 地址。 說明
當 InstanceType 配置為 NetworkInterface 時，該參數(shù)必填，需輸入要綁定的私網(wǎng) IP。
| 192.168.XX.XX |
| Mode | string | 否 | 綁定模式，取值：
說明
僅 InstanceType 配置為 NetworkInterface 時，才需要配置該參數(shù)。
| NAT |
| VpcId | string | 否 | 開通了 IPv4 網(wǎng)關功能且與 EIP 同地域的 VPC ID。 EIP 綁定 IP 地址時，系統(tǒng)可以根據(jù)該 VPC 的路由配置，使綁定的 IP 地址具備公網(wǎng)訪問能力。 說明
InstanceType 取值為 IpAddress 時，即要綁定 EIP 的實例類型為 IP 地址時，該參數(shù)必填。
| vpc-257gqcdfvx6n**** |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 0c593ea1-3bea-11e9-b96b-88e9fe63**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidAssociation.Duplicated | Specified instance already is associated. | 該實例已綁定EIP或全球加速實例，不能再綁定，如需更換實例綁定的EIP或全球加速實例，請先解綁。 |
| 400 | OperationDenied | Specified instance is not in VPC. | 該實例在VPC中不存在。 |
| 400 | InvalidParameter.Mismatch | Specified elastic IP address and ECS instance are not in the same region. | 該EIP和ECS實例不在同一個地域內。 |
| 400 | IncorrectEipStatus | Current elastic IP status does not support this operation | 當前EIP的狀態(tài)不支持該操作。 |
| 400 | IncorrectInstanceStatus | Current instance status does not support this operation. | 當前實例的狀態(tài)不支持該操作。 |
| 400 | InvalidInstanceType.ValueNotSupported | The specified value of InstanceType is not supported. | 參數(shù)InstanceType的值不合法。 |
| 400 | IncorrectHaVipStatus | HaVip can be operated by this action only when it's status is Available or InUse. | Havip實例為Available或InUse才允許操作 |
| 400 | InvalidParameter | The specified parameter is not valid. | 該參數(shù)值不合法。 |
| 400 | OperationDenied | Eip of default vpc not allow this operation | 默認專有網(wǎng)絡的EIP不支持該操作。 |
| 400 | TaskConflict | The eip operate too frequent, TaskConflict. | 操作過于頻繁，任務沖突。 |
| 400 | InvalidBindingStatus | The eip binding status invalid. | EIP綁定狀態(tài)不正確。 |
| 400 | BIND_INSTANCE_HAVE_PORTMAP_OR_BIND_EIP | The instance may have portMap or already bind eip. | ECS 實例已經(jīng)存在端口轉發(fā)規(guī)則，請刪除相應的端口轉發(fā)規(guī)則再進行操作。 |
| 400 | EIP_CAN_NOT_ASSOCIATE_WITH_PUBLIC_IP | instance already bind natpublicip,cannot bind eip. | - |
| 400 | BIND_INSTANCE_OWENER_ERROR | Cannot operate the eip. | 不能操作這個EIP。 |
| 400 | NATGATEWAY_FINANCIALLOCKED | The NatGateway has expire, cannot do bind operation. | - |
| 400 | InvalidParameter.InstanceTypeNotSupport | The specified instance type is not support. | - |
| 400 | QuotaExceeded.NumberOfTrafficEip | The number of traffic eip on natgw exceed limitation. | - |
| 400 | QuotaExceeded.NumberOfEip | Binded eip Quota exceed on this NatGw. | 此NAT網(wǎng)關上，綁定的EIP數(shù)量已經(jīng)超出配額限制 |
| 400 | Forbidden.EipCanNotBindGatgw | Eip can not bind on natgw. | - |
| 400 | InvalidAction.Denied | Action is denied due to unfinished Eip configuration modification. | 由于未完成Eip配置修改，操作被拒絕。 |
| 400 | InstanceType.NotSupport | The instance type is invalid. | - |
| 400 | InvalidParams.NotFound | instance not found | 實例不存在。 |
| 400 | BindInstance.NotSupported | bind instance type %s is not supported. | - |
| 400 | Forbidden.InstanceBandwidthNotZero | Eip can not bind with instance when it's bandwidth is not zero. | - |
| 400 | INSTANCE_TYPE_NOT_SUPPORT | The instance type is invalid. | - |
| 400 | ServerRegion.Invalid | Eip bind remote server region invalid. | - |
| 400 | Eni.Attached | The eni should be detached from ecs when associating with direct eip. | 當ENI綁定直通EIP時，需要ENI與ECS解綁 |
| 400 | Eni.HasSubIp | Eni has sub ip can not bind direct eip. | - |
| 400 | Invalid.DirectEip.BindType | The direct eip can be only associated with eni. | - |
| 400 | InvalidStatus.EcsStatusNotSupport | The special instance status is not support operate | - |
| 400 | Invalid.Function.NotSupported | Multi-IP function is under test, the region or uid is not supported. | - |
| 400 | InvalidStatus.EniStatusNotSupport | %s | - |
| 400 | InvalidParameter.EniInstanceId | %s | - |
| 400 | InvalidNexthop.DirectEni | The direct Eni cannot be nexthop. | 直通Eni不能作為下一跳 |
| 400 | Mode.Conflict | The eni can bind only one mode of eip. | - |
| 400 | Mode.NotSupport | The user cannot use multi direct eip. | - |
| 400 | QuotaExceed.MultiBindedEip | The number of multi binded eip is over limit. | - |
| 400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | EIP實例被鎖定 |
| 400 | OperationFailed.EniSubIp | Eni has sub ip can not bind direct eip. | - |
| 400 | InvalidEip.EipQuotaExceeded | The specified eni assigned eip is more than privateIp. | - |
| 400 | OperationFailed.QueryCommodityInfo | Operation failed because quey commodity info error. | - |
| 400 | OperationUnsupported.MultiIp | Multi ip function is not support. | - |
| 400 | InvalidNicOrVm.NotFound | Bind nic or vm not exist. | 指定綁定的網(wǎng)卡或VM不存在。 |
| 400 | OperationUnsupported.EipBindModel | The instance type of ecs does not support MULTI_BINDED model Eip. | - |
| 400 | IncorrectStatus.NatGateway | %s | - |
| 400 | EipBindRemote.BackendRegionMustBeSingle | eip bind remote instance, backend region must be single | - |
| 400 | InvalidParameter.BindingInstanceRegion | The specified BindingInstanceRegion is not supported. | - |
| 400 | OperationFailed.HavipBoundPortmap | %s | - |
| 400 | IllegalParam.Mode | %s | - |
| 400 | InvalidStatus.NotAllow | Bind instance status invalid | 綁定實例狀態(tài)無效 |
| 400 | InvalidInstance.NotExist | Bind instance data not exist | - |
| 400 | InvalidBandwidthPackageId.NotFound | The specified BandwidthPackageId not exist. | - |
| 400 | ResourceQueryError | The specified resource is queried error. | 查詢指定的資源時出錯。 |
| 400 | InvalidStatus.InstanceHasBandWidth | The specified instance bandwidth invalid. | - |
| 400 | OperationDenied.CloudBoxResourceExist | The operation is not allowed because there are resources related to the cloud box in VPC. | 指定操作被禁止，因為VPC中存在云盒相關的資源。 |
| 400 | OperationDenied.CloudBoxVSwitchExist | The operation is not allowed because a cloud box type vSwitch exists in VPC. | 指定操作被禁止，因為VPC中存在云盒類型的虛擬交換機。 |
| 400 | OperationDenied.NoAvailablePrivateIp | The operation is failed because of vSwitch has not availalbe private ip | 當前虛擬交換機下的可用私網(wǎng)IP不足 |
| 400 | UnsupportedRegion | %s | - |
| 400 | ResourceAlreadyAssociated.IpAddress | %s | - |
| 400 | OperationFailed.Ipv4GatewayNotOpenedInVpc | The operation is failed because Ipv4Gateway is not opened in Vpc. | EIP綁定IP失敗，因為該VPC未開啟IPv4網(wǎng)關. |
| 400 | OperationFailed.Ipv4GatewayNotActivatedInVpc | The operation is failed because Ipv4Gateway is not activated in Vpc. | - |
| 400 | OperationDenied.L2EipBindIpAddress | %s | - |
| 400 | Forbidden | The eip instance owner error | EIP 不屬于當前調用者，請您檢查該 EIP 是否可被您調用。 |
| 400 | Forbidden.FinancialLocked | The ip business status is invalid. | 該實例已欠費鎖定，無法操作 |
| 400 | UnsupportedFeature.EipBindIpAddress | The feature of EipBindIpAddress is not supported. | Eip綁定IpAddress特性不支持。 |
| 400 | OperationFailed.InstanceNotExist | The ECS instance does not exist, or is not a VPC VM. | ECS綁定EIP失敗，因為ECS實例不存在或不是VPC虛擬機. |
| 400 | OperationDenied.Ipv4GatewayExist | The operation is not allowed because of Ipv4GatewayExist. | EIP綁定操作失敗，因為此VPC下存在Ipv4網(wǎng)關 |
| 400 | OperationFailed.EipBindModeConflict | Eips can not bind Eni with NAT mode and MULTI_BINDED mode at the same time. | Eip不能同時以NAT模式和多EIP網(wǎng)卡可見模式綁定ENI. |
| 400 | OperationFailed.EcsMigrating | The operation is failed because of ECS is migrating. | 綁定操作失敗，因為ECS正在遷移。 |
| 400 | OperationFailed.IpPrefixConflict | The operation failed due to the IP prefix of the ENI. | 當前操作與彈性網(wǎng)卡的IP Prefix沖突。 |
| 400 | UnsupportedFeature.EipBindPrefixIp | The feature of EipBindPrefixIp is not supported. | 當前地域不支持EIP綁定PrefixIp |
| 400 | OperationDenied.UnsupportedEipBindMode | The operation is not supported for the NAT gateway due to its EIP binding mode. | 此NAT網(wǎng)關的EIP綁定類型不支持此操作。 |
| 400 | OperationDenied.Unauthorized | The operation is not allowed because the user is not in the whitelist. | 此操作不被允許，用戶不在白名單。 |
| 400 | OperationFailed.SystemBusy | Operation failed because system is busy. | 系統(tǒng)繁忙，請稍后重試 |
| 400 | OperationFailed.PrivateIpAddressNotExist | The operation failed because the PrivateIpAddress is not found. | 您傳入的私網(wǎng)IP地址不存在。 |
| 400 | IllegalParamFormat.%s | The param format of %s is illegal. | 參數(shù)模式非法 |
| 400 | MissingParam.InstanceId | The param of InstanceId can't be null or empty. | InstanceId不可以為空 |
| 404 | InvalidAllocationId.NotFound | Specified allocation ID is not found. | 指定的公網(wǎng) IP 不存在，請您檢查填寫的公網(wǎng) IP 是否正確。 |
| 404 | InvalidInstanId.NotFound | Specified instance does not exist. | 指定的實例不存在，請您檢查該實例是否正確。 |
| 404 | InvalidRegionId.NotFound | Specified value of InstanceRegionId is not supported. | - |
| 404 | InvalidAllocationId.NotFound | Specified allocation ID is not found | 指定的公網(wǎng)IP不存在，請您檢查您填寫的參數(shù)是否正確。 |
| 404 | Forbidden.RegionNotFound | Specified instance is not found during access authentication. | 當前Region不支持 |
| 404 | OperationDenied.VpcIpv4GatewayEnabled | The operation is not allowed because of the VPC of the NAT gateway has opened IPv4 Gateway. | 不允許操作，因為NAT網(wǎng)關的VPC已經(jīng)開啟IPv4網(wǎng)關 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求失敗，因為臨時服務器故障。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-18 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-09-25 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-08-24 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-06-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-03-23 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |