Attaches an Internet Shared Bandwidth instance to an Application Load Balancer instance.
Operation description
The AttachCommonBandwidthPackageToLoadBalancer operation is asynchronous. After you send the request, the system returns a request ID, but the Internet Shared Bandwidth instance is not yet associated with the load balancing instance. The association task is still running in the background. You can call the GetLoadBalancerAttribute operation to query the association status of the Internet Shared Bandwidth instance:
When the load balancing instance is in the Configuring state, the Internet Shared Bandwidth instance is being associated.
When the load balancing instance is in the Active state, the Internet Shared Bandwidth instance is associated.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:AttachCommonBandwidthPackageToLoadBalancer |
update |
*LoadBalancer
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique. |
123e4567-e89b-12d3-a456-42665***** |
| RegionId |
string |
Yes |
The region ID of the Application Load Balancer instance. You can call the DescribeRegions operation to query region IDs. |
cn-hangzhou |
| LoadBalancerId |
string |
Yes |
The ID of the Application Load Balancer instance. |
alb-d676fho813rmu3**** |
| BandwidthPackageId |
string |
Yes |
The ID of the Internet Shared Bandwidth instance to be associated. |
cbwp-bp1pzf0ym72pu3y76**** |
| DryRun |
boolean |
No |
Specifies whether to perform a dry run. Valid values:
|
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Attaches an Internet Shared Bandwidth instance to an Application Load Balancer instance. |
||
| RequestId |
string |
The request ID. |
2EF39708-974B-5E74-AFF5-3445****** |
| JobId |
string |
The ID of the asynchronous task. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
Examples
Success response
JSON format
{
"RequestId": "2EF39708-974B-5E74-AFF5-3445263035A8",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IncorrectBusinessStatus.CommonBandwidthPackage | The business status of %s [%s] is incorrect. | The business status of the resource %s [%s] is invalid. |
| 400 | IncorrectStatus.CommonBandwidthPackage | The status of %s [%s] is incorrect. | The status of the resource %s [%s] is invalid. |
| 404 | ResourceNotFound.LoadBalancer | The specified resource %s is not found. | The specified resource %s is not found. |
| 404 | ResourceNotFound.CommonBandwidthPackage | The specified resource %s is not found. | The resource %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.