接口功能介绍
创建监听器
接口约束
无
URI
POST /v4/elb/create-listener
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 区域ID | ||
| loadBalancerID | 是 | String | 负载均衡实例ID | ||
| name | 是 | String | 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | acl11 | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符： |
||
| protocol | 是 | String | 监听协议。取值范围：TCP、UDP、HTTP、HTTPS | ||
| protocolPort | 是 | Integer | 负载均衡实例监听端口。取值：1-65535 | 8080 | |
| certificateID | 否 | String | 证书ID。当protocol为HTTPS时,此参数必选 | ||
| caEnabled | 否 | Boolean | 是否开启双向认证。false（不开启）、true（开启） | false | |
| clientCertificateID | 否 | String | 双向认证的证书ID | ||
| defaultAction | 是 | Object | 默认规则动作 | defaultAction | |
| accessControlID | 否 | String | 访问控制ID | ||
| accessControlType | 否 | String | 访问控制类型。取值范围：Close（未启用）、White（白名单）、Black（黑名单） | ||
| forwardedForEnabled | 否 | Boolean | x forward for功能。false（未开启）、true（开启） | true |
表 defaultAction
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 是 | String | 默认规则动作类型。取值范围：forward、redirect | ||
| forwardConfig | 否 | Object | 转发配置，当type为forward时，此字段必填 | forwardConfig | |
| redirectListenerID | 否 | String | 重定向监听器ID，当type为redirect时，此字段必填 |
表 forwardConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroups | 是 | Array of Objects | 后端服务组 | targetGroup |
表 targetGroup
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroupID | 是 | String | 后端服务组ID | ||
| weight | 否 | Integer | 后端主机权重，取值范围：1-256。默认为100 | 100 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Array of Objects | 返回结果 | 见下表 | returnObj |
| error | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 监听器 ID | xxxx |
枚举参数
无
请求示例
请求url
POST /v4/elb/create-listener
请求头header
无
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"loadBalancerID": "lb-ai7x5ulq4t",
"name": "yacos-test-tmp",
"description": "yacos-test-tmp",
"protocol": "HTTP",
"protocolPort": 8080,
"defaultAction": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 20
}
]
},
"redirectListenerID": null
},
"certificateID": null,
"caEnabled": false,
"accessControlID": "ac-or6bz91ihq",
"accessControlType": "White",
"forwardedForEnabled": true
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"ID": "listener-4xvz5g2y5h"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
