All Products
Search
Document Center

Server Load Balancer:AttachCommonBandwidthPackageToLoadBalancer

Last Updated:Oct 12, 2024

Associates an Internet Shared Bandwidth instance with a Network Load Balancer (NLB) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
nlb:AttachCommonBandwidthPackageToLoadBalancerupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the NLB instance.

nlb-83ckzc8d4xlp8o****
BandwidthPackageIdstringYes

The ID of the EIP bandwidth plan.

cbwp-bp1pzf0ym72pu3y76****
DryRunbooleanNo

Specifies whether only to precheck the request. Valid values:

  • true: prechecks the request but does not associate the EIP bandwidth plan with the NLB instance. The system prechecks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the precheck, an HTTP 2xx status code is returned and the operation is performed.
false
ClientTokenstringNo

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 all requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId of each API request may be different.
123e4567-e89b-12d3-a456-426655440000
RegionIdstringNo

The ID of the region where the NLB instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

response

RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobIdstring

The ID of the asynchronous task.

72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.IntranetLoadBalancerThe operation is not allowed because of IntranetLoadBalancer.The operation is not allowed because of IntranetLoadBalancer.
400ResourceAlreadyAssociated.loadbalancerThe specified resource of loadbalancer is already associated.the specified load balancer has been bound to the shared bandwidth package.
400ResourceInConfiguring.loadbalancerThe specified resource of loadbalancer is being configured, please try again later.The specified resource of loadbalancer is being configured, please try again later.
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.The specified load balancer resource was not found. Please check the input parameters.
404ResourceNotFound.BandwidthPackageIdThe specified resource of BandwidthPackageId is not found.-
404ResourceNotFound.CommonBandwidthPackageThe specified resource of CommonBandwidthPackage is not found.The shared bandwidth package resource does not exist. Check the input parameters.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-22The Error code has changedView Change Details
2024-01-29The Error code has changedView Change Details
2023-10-30The Error code has changedView Change Details
2023-09-05The Error code has changedView Change Details
2023-08-22The Error code has changedView Change Details