复制已有监听器 - CloneListener
功能介绍
复制已有的监听器到同VPC内的负载均衡器。
-
仅支持同VPC实例间使用监听器复制功能。
-
不支持网关型LB下监听器进行复制，也不支持复制到网关型LB下。
-
仅同类型实例之间可以使用监听器复制功能。
-
对复制的源监听器有如下限制：后端服务器总数不能超过1000；转发策略总数不能超过100。
-
源监听器所在负载均衡器和目的监听器所在负载均衡器不能处于冻结、迁移状态。
-
源监听器中若配置quic_config，复制后为null。
-
七层转发策略配置为重定向到监听器，该转发策略不会进行复制。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v3/{project_id}/elb/listeners/{listener_id}/clone
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：项目ID。获取方式请参见获取项目ID。 约束限制：不涉及 取值范围：长度为32个字符，由小写字母和数字组成。 默认取值：不涉及 |
|
listener_id |
是 |
String |
参数解释：被复制监听器ID（UUID）。 约束限制：不涉及 取值范围：标准的UUID格式，长度为36个字符。 默认取值：不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：IAM鉴权Token。 约束限制：不涉及 取值范围：不涉及 默认取值：不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
target_listener_params |
是 |
Array of CloneListenerOption objects |
参数解释：复制后的新监听器相关配置。 约束限制：不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数解释：新监听器的名称。 约束限制：不涉及 取值范围：[0-255]个字符，传入空字符串则取默认值。 默认取值：原监听器名称+ “-copy”。 |
|
loadbalancer_id |
是 |
String |
参数解释：新监听器所在的负载均衡器ID（UUID）。 约束限制：
取值范围：标准的UUID格式，长度为36个字符。 默认取值：不涉及 |
|
protocol_port |
否 |
Integer |
参数解释：新监听器的监听端口。 约束限制：
取值范围：0-65535 默认取值：不涉及 |
|
port_ranges |
否 |
Array of PortRange objects |
参数解释：端口监听范围（闭区间)，最多指定10个端口组，每个组范围不可有重叠部分。 约束限制：
|
|
reuse_pool |
否 |
Boolean |
参数解释：新监听器是否复用或复制源监听器的后端服务器组和后端服务器的标识。
约束限制： 取值范围： 默认取值：false |
|
subnet_mapping_list |
否 |
Array of SubnetMappingList objects |
参数解释：源监听器下后端服务器子网信息和新监听器下后端服务器子网信息一一对应关系。 约束限制：
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
listener_list |
Array of CloneListenerResp objects |
参数解释：新监听器相关信息。 |
|
request_id |
String |
参数解释：请求的ID 。 取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。 |
|
job_id |
String |
参数解释：监听器复制任务的ID，任务详情可通过GET /v3/{project_id}/elb/jobs/{job_id}进行查询。 取值范围：标准的UUID格式，长度为36个字符。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释：新监听器ID。 取值范围：标准的UUID格式，长度为36个字符。 |
|
loadbalancer_id |
String |
参数解释：目的负载均衡器ID。 取值范围：标准的UUID格式，长度为36个字符。 |
|
protocol_port |
Integer |
参数解释：新监听器监听端口。 取值范围：1-65535 |
|
port_ranges |
Array of ResPortRange objects |
参数解释：端口监听范围（闭区间)。 |
请求示例
复制已有监听器。
POST https://{ELB_Endpoint}/v3/{project_id}/elb/listeners/{listener_id}/clone
{
"target_listener_params" : [ {
"name" : "xx-clone",
"loadbalancer_id" : "fb624475-734a-470a-85ed-bd8828bae924",
"protocol_port" : 425,
"reuse_pool" : false
} ]
}
响应示例
状态码：200
操作正常返回。
{
"request_id" : "11750ade-148f-4498-bd7a-e07190a1f5fe",
"job_id" : "aa132002-c0a8-473b-82b4-69fd2d6f87d2",
"listener_list" : [ {
"id" : "81fdfab0-35c0-476e-96df-e00797076843",
"loadbalancer_id" : "fb624475-734a-470a-85ed-bd8828bae924",
"protocol_port" : 425,
"port_ranges" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作正常返回。 |
错误码
请参见错误码。
