全部产品
Search
文档中心

负载均衡:AttachCommonBandwidthPackageToLoadBalancer - 实例绑定共享带宽包

更新时间:Jan 29, 2024

将共享带宽包绑定到应用型负载均衡实例上。

接口说明

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

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665*****
RegionIdstring

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

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

cn-hangzhou
LoadBalancerIdstring

应用型负载均衡实例 ID。

alb-d676fho813rmu3****
BandwidthPackageIdstring

绑定的共享带宽包 ID。

cbwp-bp1pzf0ym72pu3y76****
DryRunboolean

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

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

返回参数

名称类型描述示例值
object

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

RequestIdstring

请求 ID。

2EF39708-974B-5E74-AFF5-3445******
JobIdstring

异步任务 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史