BindNlb - 为应用绑定NLB

应用访问支持NLB

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:BindNlbcreate
*全部资源
*

请求语法

POST /pop/v1/sam/app/nlb HTTP/1.1

请求参数

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

目标应用 ID。

7171a6ca-d1cd-4928-8642-7d5cfe69****
NlbIdstring

NLB 实例 ID

nlb-7z7jjbzz44d82c9***
Listenersstring

传入要操作的 Listeners 的 JSON 数组串,每个 Listener 的具体结构描述如下:

  • Port,Integer 类型,必选,负载均衡监听端口。取值范围:0~65535。

  • TargetPort,Integer 类型,必选,实例容器监听端口。取值范围:0~65535。

  • Protocol,String 类型,必选,监听协议。取值:TCP、UDP 或 TCPSSL。

  • CertIds,String 类型,可选,服务器证书列表信息。仅对 TCPSSL 监听生效。

ZoneMappingsstring

可用区及交换机映射列表的 JSON 字符串。最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。一个 ZoneMapping 结构为:

  • VSwitchId,String 类型,可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。

  • ZoneId,String 类型,网络型负载均衡实例的可用区 ID。

vsw-sersdf**** cn-hangzhou-a
AddressTypestring

地址类型:

  • Internet:公网地址。
  • Intranet:私网地址。
Internet

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a06dfe717389800573793090e0589
Dataobject

返回结果。

ChangeOrderIdstring

返回的发布单 ID,用于查询任务执行状态。

ba386059-69b1-4e65-b1e5-0682d9fa****
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

HTTP 状态码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

批量停止应用是否成功。取值说明如下:

  • true:停止成功。
  • false:停止失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a06dfe717389800573793090e0589",
  "Data": {
    "ChangeOrderId": "ba386059-69b1-4e65-b1e5-0682d9fa****"
  },
  "ErrorCode": "空",
  "Code": 200,
  "Success": true
}

错误码

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