调用AttachCommonBandwidthPackageToLoadBalancer接口将共享带宽包绑定到应用型负载均衡实例。

使用说明

AttachCommonBandwidthPackageToLoadBalancer接口属于异步接口,即系统返回一个请求ID,但该负载均衡实例尚未绑定关联共享带宽包,系统后台的绑定任务仍在进行。您可以调用GetLoadBalancerAttribute查询共享带宽包的绑定状态:

  • 当负载均衡实例处于Configuring状态时,表示共享带宽包正在绑定中。
  • 当负载均衡实例处于Active状态时,表示共享带宽包绑定成功。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AttachCommonBandwidthPackageToLoadBalancer

系统规定参数。取值:AttachCommonBandwidthPackageToLoadBalancer

ClientToken String 123e4567-e89b-12d3-a456-426655440000

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-hangzhou

应用型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

LoadBalancerId String alb-d676fho813rmu3****

应用型负载均衡实例ID。

BandwidthPackageId String cbwp-bp1pzf0ym72pu3y76****

绑定的共享带宽包ID。

DryRun Boolean true

是否只预检此次请求。取值:

  • true:发送检查请求,不会将共享带宽包绑定到负载均衡实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。

返回数据

名称 类型 示例值 描述
RequestId String 2EF39708-974B-5E74-AFF5-3445263035A8

请求ID。

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

异步任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AttachCommonBandwidthPackageToLoadBalancer
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&LoadBalancerId=alb-d676fho813rmu3****
&BandwidthPackageId=cbwp-bp1pzf0ym72pu3y76****
&DryRun=true
&公共请求参数

正常返回示例

XML格式

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

<AttachCommonBandwidthPackageToLoadBalancerResponse>
    <RequestId>2EF39708-974B-5E74-AFF5-3445263035A8</RequestId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</AttachCommonBandwidthPackageToLoadBalancerResponse>

JSON格式

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

{
  "RequestId" : "2EF39708-974B-5E74-AFF5-3445263035A8",
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectBusinessStatus.CommonBandwidthPackage The business status of %s [%s] is incorrect. 资源%s [%s]的业务状态无效。
400 IncorrectStatus.CommonBandwidthPackage The status of %s [%s] is incorrect. 资源%s [%s]的状态无效。
404 ResourceNotFound.LoadBalancer The specified resource %s is not found. 资源%s不存在。
404 ResourceNotFound.CommonBandwidthPackage The specified resource %s is not found. 资源%s不存在。

访问错误中心查看更多错误码。