创建ip_listener
更新时间 2026-04-28 16:19:00
最近更新时间: 2026-04-28 16:19:00
接口功能介绍
创建ip_listener
接口约束
无
URI
POST /v4/iplistener/create
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| gwLbID | 是 | String | 网关负载均衡 ID | gwlb-xxx | |
| name | 是 | String | 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | test | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&()_-+= <>?:"{},./;'[]·！@#￥%……&（） —— -+={}\《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | desc | |
| action | 是 | Object | 动作配置 | action |
表 action
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 是 | String | 默认规则动作类型。取值范围：forward | forward | |
| forwardConfig | 是 | Object | 转发配置，当type为forward时，此字段必填 | fowardConfig |
表 forwardConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroups | 是 | Array of Objects | 后端服务组 | targetGroup |
表 targetGroup
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroupID | 是 | String | 后端服务组ID | tg-0xxx | |
| weight | 否 | Integer | 权重，当前只支持配置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 | Object | 接口业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ipListenerID | String | 监听器 id | listener-xxxx |
枚举参数
无
请求示例
请求url
POST /v4/iplistener/create
请求头header
无
请求体body
{
"regionID": "xxxx",
"name": "eip-test-0001234",
"gwLbID": "xxxx",
"description": "yacos-test-tmp",
"action": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 100
}
]
},
},
}
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"descritption": "成功",
"returnObj":{
"ipListenerID": "listener-xxx"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
