参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 访问控制ID, 该字段后续废弃 accessControlID 否 String 访问控制ID, 推荐使用该字段, 当同时使用 ID 和 accessControlID 时，优先使用 accessControlID

参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 资源池ID name 是 String 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 acl11 description 否 String 支持拉丁字母、中文、数字, 特殊字符：~~!@$%^&()+ <>?:{},./;'[]·~~！@￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 test type 是 String 证书类型。取值范围：Server（服务器证书）、Ca（Ca证书） privateKey 否 String 服务器证书私钥，服务器证书此字段必填 certificate 是 String type为Server该字段表示服务器证书公钥Pem内容;type为Ca该字段表示Ca证书Pem内容

枚举参数 无 请求示例 请求url POST /v4/elb/deletehealthcheck 请求头header 无 请求体body { "clientToken": "xxxx", "regionID": "81f7728662dd11ec810800155d307d5b", "healthCheckID": "hcm2zb05f7s8" } 响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功" } 状态码 请参考 状态码 错误码 请参考 错误码

响应示例 { "statusCode":800, "errorCode":"SUCCESS", "message":"success", "description":"成功", "returnObj":{ "domainCertID":"dclxxxx" } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 启动监听器 接口约束 无 URI POST /v4/elb/startlistener 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 否 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 监听器ID, 该字段后续废弃 listenerID 是 String 监听器ID, 推荐使用该字段, 当同时使用 ID 和 listenerID 时，优先使用 listenerID 响应参数 参数 参数类型 说明 示例 下级对象 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 GET /v4/elb/listaccesscontrol?regionIDxxxxx 请求头header 无 请求体body 无 响应示例 成功响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功", "returnObj": [ { "azName": null, "projectID": "0", "ID": "achlk7r4i8v6", "name": "tianyitest1", "description": "tianyi1", "sourceIps": [ "172.16.1.0/24" ], "createTime": "20221003T09: 45: 34Z" }, { "azName": null, "projectID": "0", "ID": "ac0pwgqkc0qw", "name": "t123456789012345678901234567892", "description": "t5", "sourceIps": [ "172.16.100.0/24" ], "createTime": "20221003T09: 44: 22Z" }, { "azName": null, "projectID": "0", "ID": "acce3s3j050m", "name": "t123456789012345678901234567892", "description": "t5", "sourceIps": [ "172.16.100.0/24" ], "createTime": "20221001T06: 50: 55Z" }, { "azName": null, "projectID": "0", "ID": "acru2ocyhbv4", "name": "az1", "description": "t12345678901234567890123456789t12345678901234567890123456789t12345678901234567890123456789t123456789~!@ $%^&()+<>?: " { } 012345", "sourceIps": [ "172.16.100.0/24" ], "createTime": "20221001T05: 12: 15Z" }, { "azName": null, "projectID": "0", "ID": "acs9evngds8c", "name": "tianyitest1", "description": "tianyi1", "sourceIps": [ "172.16.1.0/24" ], "createTime": "20221001T02: 55: 29Z" }, { "azName": null, "projectID": "0", "ID": "acrpuf6w2c4g", "name": "tianyi1", "description": "tianyi1", "sourceIps": [ "172.16.1.0/24" ], "createTime": "20221001T02: 10: 48Z" }, { "azName": null, "projectID": "0", "ID": "acpycz8ml4to", "name": "tianyi1", "description": "tianyi1", "sourceIps": [ "172.16.1.0/24" ], "createTime": "20221001T02: 06: 58Z" } ] }

参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS

参数 参数类型 说明 示例 下级对象 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

参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b azName String 可用区名称 az1 projectID String 项目ID 0 ID String 证书ID xxxx name String 名称 taet description String 描述 desc type String 证书类型: certificate / ca ca privateKey String 服务器证书私钥 xxx certificate String type为Server该字段表示服务器证书公钥Pem内容;type为Ca该字段表示Ca证书Pem内容 xxxx status String 状态: ACTIVE / INACTIVE ACTIVE createdTime String 创建时间，为UTC格式 20221003T09: 44: 22Z updatedTime String 更新时间，为UTC格式 20221003T09: 44: 22Z certificateExpireTime String 证书过期时间 20260113T02:14:34Z standard Integer 标准，0表示国际证书，1表示国密证书 0 signKey String 签名密钥 xxx signCert String 签名证书 xxx signCertExpireTime String 签名证书到期时间 20260113T02:14:34Z encryptKey String 加密密钥 xxx encryptCert String 加密证书 xxx encryptCertExpireTime String 加密证书到期时间 20260113T02:14:34Z

响应参数 参数 参数类型 说明 示例 下级对象 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 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 后端服务组ID target49bp8uzydb 枚举参数 无 请求示例 请求url POST /v4/elb/createtarget 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "targetGroupID": "tg71mh1rkfpn", "description": "targetdesc11", "instanceType": "VM", "instanceID": "fa16163fb4c0a912c49432f28bcef246", "protocolPort": 2000, "clientToken": "qlrsiEQSDUgkXRoFTH181AxWJ8UXGYY4a72rdDlnkRhHrj4IP3jze8U4Vd5fxJot", "weight": 256 } 响应示例 成功响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功", "returnObj": [ { "ID": "target49bp8uzydb" } ] }

参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 后端服务ID, 该字段后续废弃 targetID 是 String 后端服务ID, 推荐使用该字段, 当同时使用 ID 和 targetID 时，优先使用 targetID

参数 参数类型 说明 示例 下级对象 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 表 returnObj

参数 参数类型 说明 示例 下级对象 targetID String 后端服务ID targetxxxx

接口功能介绍 设置监听器 Establish Timeout 接口约束 不支持协议为 UDP / HTTP / HTTPS 的监听器。 URI POST /v4/elb/updatelistenerestabtimeout 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b listenerID 是 String 监听器ID listener2exqi1zcs8 establishTimeout 是 Integer 建立连接超时时间，单位秒，取值范围： 10 1800 10 响应参数 参数 参数类型 说明 示例 下级对象 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 枚举参数 无 请求示例 请求url POST /v4/elb/updatelistenerestabtimeout 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "listenerID": "listenertectlz2ji2", "establishTimeout": 1 } 响应示例 成功响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功" }

参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID listenerID 是 String 监听器ID priority 否 Integer 优先级，数字越小优先级越高，取值范围为：1100(目前不支持配置此参数,只取默认值100) 100 description 否 String 支持拉丁字母、中文、数字, 特殊字符：~~!@$%^&()+ <>?:'{},./;'[,]·~~！@￥%……&（） —— +{}, 《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 acl conditions 是 Array of Objects 匹配规则数据 conditions action 是 Object 规则目标 action

工作原理 天翼云资源池，针对四层的TCP请求（TCP监听器），可以通过下述两种方式获取客户端源IP： 1. 在后端主机内配置TOA插件获取客户端的真实源IP地址。TOA是操作系统的内核模块，需要在ELB后端主机中安装TOA插件，以实现后端主机可获取客户端真实源IP地址的目的。具体操作参考——操作步骤（TOA模式）。 2. 在后端主机组上打开“获取客户端真实源IP”（该功能不支持平滑开启，切换到ProxyProtocol需要业务停服升级，请谨慎配置）开关，并在后端主机里开启Proxy Protocol后获取到客户端真实源IP。具体操作参考——操作步骤（Proxy Protocol模式）。该功能具体支持情况请以控制台显示为准。 说明 “获取客户端真实源IP”需要代理服务器和后端主机都支持该协议才能正常使用。如果后端主机不具备解析Proxy Protocol协议能力，打开特性开关可能会导致后端服务解析异常，从而影响服务可用性。 对于操作步骤（Proxy Protocol模式）实际支持情况以控制台展现为准。 操作步骤 TOA模式 1. 准备编译环境 a. 针对Linux内核版本为3.0以上的操作系统。以Centos环境为例。 b. 安装gcc编译器，执行以下命令： sudo yum install gcc c. 安装make工具，执行以下命令： sudo yum install make d. 安装内核模块开发包，执行以下命令： sudo yum install kerneldeveluname r e. 注意开发包的版本需要与内核版本一致，假如自带源里没有对应的内核开发包，可以到以下链接地址进行下载，地址如下： 以3.10.01160.80.1.0.1.el7.x8664为例，下载后执行以下命令安装： rpm ivh kerneldevel3.10.01160.80.1.0.1.el7.x8664.rpm f. 以下步骤是以Ubuntu、Debian环境为例，进行编译环境准备。 g. 安装gcc编译器，执行以下命令： sudo aptget install gcc h. 安装make工具，执行以下命令： sudo aptget install make i. 安装内核模块开发包，执行以下命令： sudo aptget install linuxheadersuname r 2. 编译内核模块 a. 下载TOA内核模块源代码，点击进入常见TOA下载页面 （获取验证码：t7nv）进行下载。 b. 编译模块。执行以下命令： cd src make c. 编译过程若未提示warning或者error，说明编译成功，检查当前目录下是否已经生成toa.ko文件。 3. 加载内核模块 a. 加载内核模块，执行以下命令： sudo insmod toa.ko b. 验证模块加载情况及内核输出信息，执行以下命令： dmesg grep TOA 假如提示信息中包含“TOA: toa loaded”，则证明内核模块已经加载成功。 说明 当CoreOS在容器中编译完内核模块后，需要将内核模块复制到宿主系统，最后在宿主系统中加载内核模块。另外由于编译内核模块的容器和宿主系统共享/lib/modules目录，可以在容器中将内核模块复制到该目录下，以供宿主系统使用 4. 自动加载内核模块 a. 把加载TOA内核模块的命令加到您的启动脚本中，能够保证TOA内核模块在系统启动时生效。 b. 在自定义的启动脚本中添加加载TOA内核模块的命令。具体步骤可参考以下操作： c. 在“/etc/sysconfig/modules/”目录下新建toa.modules文件。该文件包含了TOA内核模块的加载脚本。toa.modules文件内容，请参考如下示例：

参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS

参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 监听器ID, 该字段后续废弃 listenerID 是 String 监听器ID, 推荐使用该字段, 当同时使用 ID 和 listenerID 时，优先使用 listenerID

参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS returnObj Object ID returnObj

参数 参数类型 说明 示例 下级对象 ID String 后端主机组ID target49bp8uzydb

参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS

参数 参数类型 说明 示例 下级对象 results Array of Objects 接口业务数据 results totalCount Integer 列表条目数 1 currentCount Integer 分页查询时每页的行数。 1 totalPage Integer 总页数 1 表 results

参数 参数类型 说明 示例 下级对象 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

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b IDs 否 String 证书ID列表，以,分隔 cert75ex90k9v0,certr4cfhgrsss name 否 String 证书名称，以,分隔，必须与ID顺序严格对应 test type 否 String 证书类型。Ca或Server，以,分隔，必须与ID和name的顺序严格对应 Ca

枚举参数 无 请求示例 请求url GET /v4/elb/showaccesscontrol?regionIDxxxxx&accessControlIDxxx 请求头header 无 请求体body 无 响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功", "returnObj": { "azName": null, "projectID": "0", "ID": "ac0pwgqkc0qw", "name": "t123456789012345678901234567892", "description": "t5", "sourceIps": [ "172.16.100.0/24" ], "createTime": "20221003T09: 44: 22Z" } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b targetGroupID 是 String 后端服务组ID xxxxxxxx targets 是 Array of Objects 后端服务主机 见下表 targets

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 ipListenerID 是 String 监听器 ID listnerxxx name 否 String 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@$%^& ()+ <>?:"{},./;'[]·！@￥%……& （） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc targetGroupID 否 String 后端组 ID tg0xxx weight 否 Integer 转发权重, 取值范围 0 256 100

参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID domainName 是 String 整个域名的总长度不能超过 255 个字符，每个子域名（包括顶级域名）的长度不能超过 63 个字符，域名中的字符集包括大写字母、小写字母、数字和连字符（减号），连字符不能位于域名的开头 example.com certificateID 是 String 证书 ID certxxxxx listenerID 是 String 监听器 ID listenerxxxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~~!@$%^&()+ <>?:{},./;'[]·~~！@￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 test

枚举参数 无 请求示例 请求url GET /v4/elb/showtarget?regionID81f7728662dd11ec810800155d307d5b&targetIDtargetxxxx 请求头header 无 请求体body 无 响应示例 成功响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功", "returnObj": { "regionID": "81f7728662dd11ec810800155d307d5b", "azName": null, "projectID": "0", "ID": "targetcjh730fhyz", "targetGroupID": "tga0b3nix40g", "description": "yacosupdate", "instanceType": "VM", "instanceID": "7c7490ef7ef41df2f8c9af1ba6565de5", "protocolPort": 8000, "weight": 50, "healthCheckStatus": "unknown", "healthCheckStatusIpv6": "unknown", "status": "ACTIVE", "createdTime": "20221001T06: 16: 18Z", "updatedTime": "20221001T06: 19: 35Z" } } 失败响应示例 { "statusCode": 900, "message": "request param error", "description": "参数错误", "errorCode": "Openapi.Parameter.Error" } 状态码 请参考 状态码 错误码 请参考 错误码

响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功" } 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url POST /v4/elb/createaccesscontrol 请求头header 无 请求体body { "clientToken": "xxxxxxxxx", "regionID": "100054c0416811e9a6690242ac110002", "name": "test", "sourceIps": [ "192.168.0.1/24" ] } 响应示例 成功响应示例 { "statusCode": 800, "message": "success", "description": "成功", "errorCode": "SUCCESS", "returnObj": { "ID": "xxxxx" } } 失败响应示例 { "statusCode": 900, "message": "request param error", "description": "参数错误", "errorCode": "Openapi.Parameter.Error" } 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url POST /v4/elb/stoplistener 请求头header 无 请求体body { "clientToken": "xxxx", "regionID": "81f7728662dd11ec810800155d307d5b", "ID": "listenertectlz2ji2" } 响应示例 { "statusCode": 800, "errorCode": "SUCCESS", "message": "success", "description": "成功", "returnObj": [ { "ID": "listener2exqi1zcs8" } ] } 状态码 请参考 状态码 错误码 请参考 错误码