接口功能介绍
更新监听器。
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息，如资源池概况信息查询结果为"regionVersion":"v4.0",即可使用；如资源池概况信息结果为"regionVersion":"v3.0",请使用API（旧版）内接口更新监听器（旧版）。
URI
POST /v4/elb/update-listener
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 区域ID | |
| ID | String | 是 | 监听器ID | |
| name | String | 否 | 监听器名称，唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | |
| description | String | 否 | 描述 | |
| certificateID | String | 否 | 证书ID | |
| caEnabled | Boolean | 否 | 是否开启双向认证。false（不开启）、true（开启） | true |
| clientCertificateID | String | 否 | 双向认证的证书ID | |
| defaultAction | Object | 否 | 默认规则动作 | |
| accessControlID | String | 否 | 访问控制ID | |
| accessControlType | String | 否 | 访问控制类型。Close（未启用）、White（白名单）、Black（黑名单） | Close |
| forwardedForEnabled | Boolean | 否 | x forward for功能。false（未开启）、true（开） | true |
表 defaultAction
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | String | 是 | 默认规则动作类型。取值范围： forward、redirect、deny(目前暂不支持配置为deny) | |
| forwardConfig | Object | 否 | 转发配置 | |
| redirectListenerID | String | 否 | 重定向监听器ID，当type为redirect时，此字段必填 |
表 forwardConfig
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| targetGroups | Array of Object | 否 | 后端服务组 |
表 targetGroup
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| targetGroupID | String | 是 | 后端服务组ID | |
| weight | Integer | 否 | 权重，取值范围：1-256。默认为100 | 100 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | 错误信息的英文描述 | success |
| description | String | 返回信息说明，如果请求成功，返回空字符串；否则为错误信息。 | |
| errCode | String | 错误描述 | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ID | String | 监听器 ID | xxxxx |
请求示例
POST /v4/elb/update-listener
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"ID": "Xxxx"
"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,
"clientToken": "123e4567-b89b-12d3-a456-62665544001"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [{
"ID": "listener-4xvz5g2y5h"
}]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
