Add EIP to Shared Bandwidth via OpenAPI - Internet Shared Bandwidth - Alibaba Cloud - Internet Shared Bandwidth

Adds an elastic IP address (EIP) to an Internet Shared Bandwidth instance.

Operation description

Before you invoke this operation, take note of the following information:

When you invoke this operation to add an EIP to an Internet Shared Bandwidth instance, the EIP must meet the following conditions:
- The billing method of the EIP is pay-as-you-go.
- The EIP is in the same region as the Internet Shared Bandwidth instance.
- The line type of the EIP is the same as that of the Internet Shared Bandwidth instance.
The AddCommonBandwidthPackageIp operation is asynchronous. After you send a request, the system returns a request ID. However, the EIP is not yet added to the Internet Shared Bandwidth instance. The addition node is still running in the background. You can invoke DescribeCommonBandwidthPackages to query the association status between the Internet Shared Bandwidth instance and the EIP.
- If the association status is BINDING, the Internet Shared Bandwidth instance is being associated with the EIP. In this state, you can only execute query operations.
- If the association status is BINDED, the Internet Shared Bandwidth instance is associated with the EIP.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:AddCommonBandwidthPackageIp

create

*BandwidthPackage

acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Internet Shared Bandwidth instance. You can call DescribeRegions to query the region ID.	cn-hangzhou
BandwidthPackageId	string	Yes	The ID of the Internet Shared Bandwidth instance.	cbwp-2ze2ic1xd2qeqasdf****
IpInstanceId	string	Yes	The ID of the EIP. You can call DescribeEipAddresses to query the ID of the EIP.	eip-2zeerraiwb7uqwed****
IpType	string	No	The IP type. Set the value to EIP, which specifies that an EIP is added to the Internet Shared Bandwidth instance.	EIP
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	01FDDD49-C4B7-4D2A-A8E5-A93915C450A6

Examples

Success response

JSON format

{
  "RequestId": "01FDDD49-C4B7-4D2A-A8E5-A93915C450A6"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.SecurityProtectionTypesInconsistent	The operation is not allowed because of SecurityProtectionTypesInconsistent.
400	IpInstanceId.AlreadyInBandwidthPackage	The specified Eip InstanceId already in bandwidthPackage.	The specified Eip InstanceId already in bandwidthPackage.
400	IpInstanceId.BizStatusInvalid	The specified Eip BizStatus is Disable, Cannot add to bandwidthPackage.
400	IpInstanceId.ChargeType.NotSupport	The specified Eip instance is PrePaid type, Cannot add to BandwidthPackage.
400	BandwidthPackageId.InvalidBizStatus	The specified BandwidthPackageId has been FinancialLocked, Cannot add Ip.
400	IpInstanceId.QuotaExceeded	The specified BandwidthPackageId has too many ip in it. exceed the quota , Cannot add more.
400	EipOperation.TooFrequently	The specified Eip add into bandwidthPackage too frequently. please add later.
400	TaskConflict	The operation is too frequent, TaskConflict.	The system is unavailable. Try again later.
400	IncorrectStatus.Eip	Eip status error.
400	OperationUnsupported.IpType	Ip type does not support the operation.
400	ParamExclusive.IpInstanceIdAndBandwidthPackageId	%s
400	InvalidBandwidthPackage.NotExist	Eip bandwidth package not exist.
400	OperationFailed.DistibuteLock	Distibute lock fail.	The operation is locked by another request;
400	OperationFailed.ZoneIdInconsistent	%s
400	AttrMismatching.BandwidthPackageIpVersion	%s
400	InvalidBandwidthPackageId.NotFound	The specified BandwidthPackageId not exist.
400	InvalidInstanceId.NotFound	The InstanceId is not found.	The InstanceId is not found.
400	InvalidEIPStatus.BizDisabled	The EIP has been locked.	The error message returned because the EIP is locked.
400	Forbidden.FinancialLocked	The ip business status is invalid.	The error message returned because the instance has overdue payments.
400	Mismatch.CloudBoxCbwpZoneAndEipZone	The CbwpZone and EipZone are mismatched.	The EIP bandwidth plan of the cloud box does not match the zone of the EIP.
400	MissingParam.BandwidthPackageId	The parameter bandwidthPackageId is mandatory.	The parameter bandwidthPackageId is mandatory.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.
404	InvalidBandwidthPackageId.NotFound	The specified bandwidthPackageId does not exist in our records.
404	InvalidIpInstanceId.NotFound	The specified Eip InstanceId does not exist in our records.
404	IpInstanceId.InvalidIpInternetChargeType	The hybrid type eip not support add into bandwidthPackage of PayBytraffic type.
404	BandwidthPackageId.InvalidBandwidth	The hybrid type eip can not add into low bandwidth bandwidthPackage.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.