华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String IAM 鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ipgroup 否 BatchDeleteIpListOption object 批量删除IP地址组中的IP。 表4 BatchDeleteIpListOption 参数 是否必选 参数类型 描述 ip_list 否 Array of IpGroupIp objects IP列表。 表5 IpGroupIp 参数 是否必选 参数类型 描述 ip 是 String IP地址，可以是具体的IP地址或者IP地址段。

响应消息 表5 响应参数 参数 参数类型 描述 pool Object 后端云服务器组对象。详见表6。 表6 pools字段说明 参数 参数类型 描述 id String 后端云服务器组 ID。 tenant_id String 后端云服务器组所属的项目 ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指后端云服务器组所属的项目 ID。 name String 后端云服务器组名称。 支持的最大字符长度：255 description String 后端云服务器组的描述信息。 支持的最大字符长度：255 protocol String 后端云服务器组的后端协议。 取值范围：TCP、UDP和HTTP。 当指定listener_id创建后端云服务器组时，后端云服务器组的protocol和它关联的监听器的protocol有如下关系： 监听器的protocol为UDP时，后端云服务器组的protocol必须为UDP； 监听器的protocol为TCP时，后端云服务器组的protocol必须为TCP； 监听器的protocol为HTTP或TERMINATED_HTTPS时，后端云服务器组的protocol必须为HTTP。 lb_algorithm String 后端云服务器组的负载均衡算法。 取值范围： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 members Array 后端云服务器组关联的后端云服务器ID的列表。 healthmonitor_id String 后端云服务器组关联的健康检查的ID。 admin_state_up Boolean 后端云服务器组的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 listeners Array 后端云服务器组关联的监听器ID列表。 loadbalancers Array 后端云服务器组关联的负载均衡器ID列表。 session_persistence Object 后端云服务器组的会话持久性。详见表9。 当开启会话保持后，在一定时间内，来自同一客户端的请求会发送到同一个后端云服务器上。 取值范围：当会话保持关闭时，该字段取值为null。 表7 members字段说明 参数 参数类型 描述 id String 关联的后端服务器id 表8 listeners字段说明 参数 参数类型 描述 id String 关联的后端服务器组id 表9 loadbalancers字段说明 参数 参数类型 描述 id String 关联的负载均衡器id 表10 session_persistence字段说明 参数 参数类型 描述 type String 会话保持的类型。 取值范围： SOURCE_IP：根据请求的源IP，将同一IP的请求发送到同一个后端云服务器上。 HTTP_COOKIE：客户端第一次发送请求时，负载均衡器自动生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 APP_COOKIE：客户端第一次发送请求时，后端服务器生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 当后端云服务器组的protocol为TCP时，只按SOURCE_IP生效；当后端云服务器组的protocol为HTTP时，只按HTTP_COOKIE、APP_COOKIE生效。 cookie_name String cookie名称。 当会话保持类型是APP_COOKIE时，为必选字段，其它类型时不可指定。 persistence_timeout Integer 会话保持的超时时间。 当type为APP_COOKIE时不生效。 取值范围： [1,60]（分钟）：当后端云服务器组的protocol为TCP、UDP时。 [1,1440]（分钟）：当后端云服务器组的protocol为HTTP、HTTPS时。

响应示例 响应样例1 { "pool": { "lb_algorithm": "LEAST_CONNECTIONS", "protocol": "HTTP", "description": "pool two", "loadbalancers": [ { "id": "63ad9dfe-4750-479f-9630-ada43ccc8117" } ], "admin_state_up": true, "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "session_persistence": { "cookie_name": null, "type": "HTTP_COOKIE", "persistence_timeout": 1 }, "healthmonitor_id": null, "listeners": [ { "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829" } ], "members": [], "id": "12ff63af-4127-4074-a251-bcb2ecc53ebe", "name": "pool2" } }

请求示例 请求样例1 更新后端云服务器组 PUT https://{Endpoint}/v2.0/lbaas/pools/12ff63af-4127-4074-a251-bcb2ecc53ebe { "pool": { "name": "pool2", "description": "pool two", "lb_algorithm": "LEAST_CONNECTIONS" } }

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 pool 是 Object 后端云服务器组对象。详见表3。 表3 pool字段说明 参数 是否必选 参数类型 描述 name 否 String 后端云服务器组名称。 支持的最大字符长度：255 description 否 String 后端云服务器组的描述信息。 支持的最大字符长度：255 lb_algorithm 否 String 后端云服务器组的负载均衡算法。 取值范围： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 admin_state_up 否 Boolean 后端云服务器组的管理状态。 该字段为预留字段，暂未启用。默认为true。 session_persistence 否 Object 后端云服务器组的会话持久性。详见表10。 当开启会话保持后，在一定时间内，来自同一客户端的请求会发送到同一个后端云服务器上。 取值范围：当会话保持关闭时，该字段取值为null。 表4 session_persistence字段说明 参数 是否必选 参数类型 描述 type 否 String 会话保持的类型。 取值范围： SOURCE_IP：根据请求的源IP，将同一IP的请求发送到同一个后端云服务器上。 HTTP_COOKIE：客户端第一次发送请求时，负载均衡器自动生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 APP_COOKIE：客户端第一次发送请求时，后端服务器生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 当后端云服务器组的protocol为TCP时，只按SOURCE_IP生效；当后端云服务器组的protocol为HTTP时，只按HTTP_COOKIE、APP_COOKIE生效。 cookie_name 否 String cookie名称。 只有当会话保持的类型是APP_COOKIE时可以指定，且当会话保持的类型是APP_COOKIE时，为必选字段。 persistence_timeout 否 Integer 会话保持的超时时间。 当type为APP_COOKIE时不生效。 取值范围： [1,60]（分钟）：当后端云服务器的protocol为TCP、UDP时。 [1,1440]（分钟）：当后端云服务器的protocol为HTTP、HTTPS时。

响应示例 响应样例1 { "healthmonitor": { "name": "", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "domain_name": null, "delay": 10, "expected_codes": "200", "max_retries": 10, "http_method": "GET", "timeout": 10, "pools": [ { "id": "bb44bffb-05d9-412c-9d9c-b189d9e14193" } ], "url_path": "/", "type": "HTTP", "id": "61c24cba-19bb-45c1-a013-7565e5f98872", "monitor_port": 112 } }

响应消息 表2 响应参数 参数 参数类型 描述 healthmonitor Healthmonitor object 健康检查对象。详见表3。 表3 healthmonitor字段说明 参数 参数类型 描述 id String 健康检查ID。 tenant_id String 健康检查所在的项目ID。 project_id String 此参数和tenant_id参数含义一样，均指健康检查所在的项目ID。 name String 健康检查名称。 delay Integer 健康检查间隔，单位秒，取值范围[1，50]。 max_retries Integer 健康检查最大重试次数，取值范围[1，10]。 pools Array of Pools objects 健康检查关联的后端云服务器组的ID列表。详见表6 admin_state_up Boolean 健康检查的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 timeout Integer 健康检查超时时间，单位秒，取值范围[1，50]。 说明： 建议该值小于delay的值。 type String 健康检查的类型。 取值范围：TCP、UDP_CONNECT、HTTP。 monitor_port Integer 健康检查端口号，取值范围[1，65535]。 默认为空，表示使用后端云服务器的protocol_port作为健康检查的检查端口。 expected_codes String 期望HTTP响应状态码，指定下列值： 单值，例如200； 列表，例如200，202； 区间，例如200-204。 仅当type为HTTP时生效。 暂时不支持该字段，统一置为200。 domain_name String 健康检查时，发送的http请求的 域名 。 仅当type为HTTP时生效。 默认为空，表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头，只能包含数字、字母、’-’、’.’。 例如：www.test.com url_path String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如：“/test” http_method String HTTP请求的方法；默认值：GET 取值范围：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明： 该字段为预留字段，暂未启用。 表4 pools字段说明 参数 是否必选 参数类型 描述 id 是 String 后端服务器组id

功能介绍 返回租户创建LB时可使用的可用区集合列表情况。 默认情况下，会返回一个可用区集合。 在（如创建LB）设置可用区时，填写的可用区必须包含在可用区集合中、为这个可用区集合的子集。 特殊场景下，部分客户要求负载均衡只能创建在指定可用区集合中，此时会返回客户定制的可用区集合。 返回可用区集合可能为一个也可能为多个，比如列表有两个可用区集合[az1,az2],[az2,az3]。 在创建负载均衡器时，可以选择创建在多个可用区，但所选的多个可用区必须同属于其中一个可用区集合， 如可以选az2和az3，但不能选择az1和az3。你可以选择多个可用区，只要这些可用区在一个子集中

响应示例 状态码： 200 操作正常返回。 { "availability_zones" : [ [ { "state" : "ACTIVE", "code" : "az1", "protocol" : [ "L4", "L7" ], "public_border_group" : "center", "category" : 0 }, { "state" : "ACTIVE", "code" : "az2", "protocol" : [ "L4" ], "public_border_group" : "center", "category" : 0 }, { "state" : "ACTIVE", "code" : "az3", "protocol" : [ "L7" ], "public_border_group" : "center", "category" : 0 }, { "state" : "ACTIVE", "code" : "homezone.az0", "protocol" : [ "L4" ], "public_border_group" : "homezone.azg", "category" : 21 } ] ], "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77" }

响应示例 状态码： 200 操作正常返回。 { "request_id" : "46b7d911-cece-408c-a2cc-55c78ab025d8", "loadbalancers" : [ { "id" : "65672f7e-2024-4c39-9198-98249da479c5", "project_id" : "057ef081eb00d2732fd1c01a9be75e6f", "name" : "dxq_2021_07_26_11_12_37", "description" : "", "vip_port_id" : "b289f890-a6fa-4405-a9cc-fe62b8a3bed0", "vip_address" : "172.16.0.152", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "dc9572eb-a5b2-47b3-a982-44892d833892" } ], "pools" : [ { "id" : "dc6b01c4-f704-4427-a4c2-21cd5f58d177" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T03:12:37Z", "updated_at" : "2021-07-26T03:12:37Z", "vpc_id" : "6e0ee31f-7a46-4530-b32f-ce41f30959d4", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1" ], "ipv6_vip_address" : "2001:db8:a583:4cb:d6b8:f8b4:4211:fe72", "ipv6_vip_virsubnet_id" : "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee", "ipv6_vip_port_id" : "5186bb47-24e5-4171-b795-62d22846db9b", "publicips" : [ ], "elb_virsubnet_ids" : [ "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "aa06b26b-9ff9-43c6-92b9-41e0f746bca6", "l4_scale_flavor_id" : null, "l7_flavor_id" : "e2a5675c-a181-444e-b9a5-17b052dc7fb9", "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : "96e52038-7983-462f-8a96-415d8a280b13", "public_border_group" : "center", "log_topic_id" : null, "log_group_id" : null }, { "id" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe", "project_id" : "057ef081eb00d2732fd1c01a9be75e6f", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "0ae21c37-8b90-4e73-8a35-eedde6d2538c" } ], "pools" : [ { "id" : "904ecca6-8ebb-4974-9c5c-61d1d66fba17" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T02:46:31Z", "updated_at" : "2021-07-26T02:46:59Z", "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "publicip_address" : "97.97.2.171", "ip_version" : 4 } ], "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ { "eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171", "ip_version" : 4 } ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "public_border_group" : "center", "log_topic_id" : null, "log_group_id" : null } ], "page_info" : { "next_marker" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe", "previous_marker" : "65672f7e-2024-4c39-9198-98249da479c5", "current_count" : 2 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 loadbalancers Array of LoadBalancer objects Loadbalancer的列表。 page_info PageInfo object 负载均衡器分页信息。 request_id String 请求ID。 注：自动生成 。 表5 LoadBalancer 参数 参数类型 描述 id String 负载均衡器ID。 description String 负载均衡器描述信息。 最小长度：1 最大长度：255 provisioning_status String 负载均衡器的配置状态。 取值： ACTIVE：使用中。 PENDING_DELETE：删除中。 admin_state_up Boolean 负载均衡器的管理状态。取值：false停用，true启用。 provider String 负载均衡器的生产者名称。固定为vlb。 pools Array of PoolRef objects 负载均衡器直接关联的后端云服务器组的ID列表。 listeners Array of ListenerRef objects 负载均衡器关联的监听器的ID列表。 operating_status String 负载均衡器的操作状态。 取值： ONLINE：在线。 name String 负载均衡器的名称。 project_id String 负载均衡器所属的项目ID。 vip_subnet_cidr_id String 负载均衡器所在子网的IPv4子网ID。 vip_address String 负载均衡器的IPv4虚拟IP地址。 vip_port_id String 负载均衡器的IPv4对应的port ID。 tags Array of Tag objects 负载均衡的标签列表。 created_at String 负载均衡器的创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' updated_at String 负载均衡器的更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' guaranteed Boolean 是否独享型LB。 取值： false：共享型。 true：独享型。 vpc_id String 负载均衡器所在VPC ID。 eips Array of EipInfo objects 负载均衡器绑定的EIP。只支持绑定一个EIP。 注：该字段与publicips一致。 ipv6_vip_address String 双栈类型负载均衡器的IPv6地址。 ipv6_vip_virsubnet_id String 双栈类型负载均衡器所在子网的IPv6网络ID。 ipv6_vip_port_id String 双栈类型负载均衡器的IPv6对应的port ID。 availability_zone_list Array of strings 负载均衡器所在的可用区列表。 enterprise_project_id String 企业项目ID。创建时不传则返回"0"，表示资源属于default企业项目。 注："0"并不是真实存在的企业项目ID，在创建、更新和查询时不能作为请求参数传入。 billing_info String 资源账单信息。 取值： 空：按需计费。 最小长度：1 最大长度：1024 l4_flavor_id String 四层Flavor ID。 对于弹性扩缩容实例，表示上限规格。 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：255 l4_scale_flavor_id String 四层弹性Flavor ID。 不支持该字段，请勿使用。 最小长度：1 最大长度：255 l7_flavor_id String 七层Flavor ID。 对于弹性扩缩容实例，表示上限规格ID。 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：255 l7_scale_flavor_id String 七层弹性Flavor ID。 不支持该字段，请勿使用。 最小长度：1 最大长度：255 publicips Array of PublicIpInfo objects 负载均衡器绑定的公网IP。只支持绑定一个公网IP。 注：该字段与eips一致。 global_eips Array of GlobalEipInfo objects 负载均衡器绑定的global eip。只支持绑定一个globaleip。 elb_virsubnet_ids Array of strings 下联面子网的网络ID列表。 elb_virsubnet_type String 下联面子网类型 ipv4：ipv4 dualstack：双栈 ip_target_enable Boolean 是否启用跨VPC后端转发。 开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。 仅独享型负载均衡器支持该特性。 取值： true：开启。 false：不开启。 使用说明： 开启不能关闭。 frozen_scene String 负载均衡器的冻结场景。 若负载均衡器有多个冻结场景，用逗号分隔。 取值： POLICE：公安冻结场景。 ILLEGAL：违规冻结场景。 VERIFY：客户未实名认证冻结场景。 PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。 AREAR：欠费冻结场景。 ipv6_bandwidth BandwidthRef object 带宽对象ID，仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。 deletion_protection_enable Boolean 是否开启删除保护。 取值： false：不开启。 true：开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 仅当前局点启用删除保护特性后才会返回该字段。 autoscaling AutoscalingRef object 弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。 使用说明： 仅当租户白名单放开后该字段才有效 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 public_border_group String LB所属AZ组 charge_mode String 收费模式。取值： flavor：按规格计费 lcu：按使用量计费 waf_failure_action String WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认） 使用说明：只有绑定了waf的LB实例，该字段才会生效。 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 log_group_id String LB所绑定的logtank对应的group id log_topic_id String LB所绑定的logtank对应的topic id 表6 PoolRef 参数 参数类型 描述 id String 后端服务器组ID。 表7 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表8 Tag 参数 参数类型 描述 key String 标签键 最小长度：1 最大长度：36 value String 标签值 最小长度：0 最大长度：43 表9 EipInfo 参数 参数类型 描述 eip_id String eip_id eip_address String eip_address ip_version Integer IP版本号。 取值：4表示IPv4,6表示IPv6。 表10 PublicIpInfo 参数 参数类型 描述 publicip_id String 弹性公网ip配置id publicip_address String IP地址 ip_version Integer IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6 表11 GlobalEipInfo 参数 参数类型 描述 global_eip_id String global eip的id global_eip_address String global eip的ip地址 ip_version Integer IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6 表12 BandwidthRef 参数 参数类型 描述 id String 共享带宽的id 表13 AutoscalingRef 参数 参数类型 描述 enable Boolean 当前负载均衡器是否开启弹性扩缩容。 取值： true：开启。 false：不开启，默认值。 min_l7_flavor_id String 弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 最小长度：1 最大长度：36 表14 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。

请求示例 分页查询负载均衡器列表 GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?limit=2&marker=87627cb6-9ff1-4580-984f-cc564fa9fc34 查询多个负载均衡器信息 GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?id=87627cb6-9ff1-4580-984f-cc564fa9fc34&id=09e86f09-03fc-440e-8132-03f3e149e979

URI GET /v3/{project_id}/elb/loadbalancers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 负载均衡器所在的项目ID。 最小长度：1 最大长度：255 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 上一页最后一条记录的ID。 使用说明： 必须与limit一起使用。 不指定时表示查询第一页。 该字段不允许为空或无效的ID。 limit 否 Integer 每页返回的个数。 最小值：0 最大值：2000 缺省值：2000 page_reverse 否 Boolean 是否反向查询。 取值： true：查询上一页。 false：查询下一页，默认。 使用说明： 必须与limit一起使用。 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 id 否 Array 负载均衡器ID。 支持多值查询，查询条件格式：id=xxx&id=xxx。 name 否 Array 负载均衡器名称。 支持多值查询，查询条件格式：name=xxx&name=xxx。 description 否 Array 负载均衡器的描述信息。 支持多值查询，查询条件格式：description=xxx&description=xxx。 admin_state_up 否 Boolean 负载均衡器的管理状态。 不支持该字段，请勿使用。 provisioning_status 否 Array 负载均衡器的配置状态。 取值： ACTIVE：使用中。 PENDING_DELETE：删除中。 支持多值查询，查询条件格式：provisioning_status=xxx&provisioning_status=xxx。 operating_status 否 Array 负载均衡器的操作状态。 取值： ONLINE：正常运行。 FROZEN：已冻结。 支持多值查询，查询条件格式：operating_status=xxx&operating_status=xxx。 guaranteed 否 Boolean 是否独享型LB。 取值： false：共享型 true：独享型 vpc_id 否 Array 负载均衡器所在的VPC ID。 支持多值查询，查询条件格式：vpc_id=xxx&vpc_id=xxx。 vip_port_id 否 Array 负载均衡器的IPv4对应的port ID。 支持多值查询，查询条件格式：vip_port_id=xxx&vip_port_id=xxx。 vip_address 否 Array 负载均衡器的IPv4虚拟IP地址。 支持多值查询，查询条件格式：vip_address=xxx&vip_address=xxx。 vip_subnet_cidr_id 否 Array 负载均衡器所在子网的IPv4子网ID。 支持多值查询，查询条件格式：vip_subnet_cidr_id=xxx&vip_subnet_cidr_id=xxx。 ipv6_vip_port_id 否 Array 双栈类型负载均衡器的IPv6对应的port ID。 支持多值查询，查询条件格式：ipv6_vip_port_id=xxx&ipv6_vip_port_id=xxx。 ipv6_vip_address 否 Array 双栈类型负载均衡器的IPv6地址。 支持多值查询，查询条件格式：ipv6_vip_address=xxx&ipv6_vip_address=xxx。 ipv6_vip_virsubnet_id 否 Array 双栈类型负载均衡器所在的子网IPv6网络ID。 支持多值查询，查询条件格式：ipv6_vip_virsubnet_id=xxx&ipv6_vip_virsubnet_id=xxx。 eips 否 Array 负载均衡器绑定的EIP。示例如下： "eips": [ { "eip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "eip_address": "88.88.14.122", "ip_version": 4 } ] 支持多值查询，查询条件格式： eip_id作为查询条件：eips=eip_id=xxx&eips=eip_id=xxx。 eip_address作为查询条件：eips=eip_address=xxx&eips=eip_address=xxx。 ip_version作为查询条件：eips=ip_version=xxx&eips=ip_version=xxx。 注：该字段与publicips字段一致。 publicips 否 Array 负载均衡器绑定的公网IP。示例如下： "publicips": [ { "publicip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "publicip_address": "88.88.14.122", "ip_version": 4 } ] 支持多值查询，查询条件格式： publicip_id作为查询条件： publicips=publicip_id=xxx&publicips=publicip_id=xxx publicip_address作为查询条件： publicips=publicip_address=xxx&publicips=publicip_address=xxx ip_version作为查询条件： publicips=ip_version=xxx&publicips=ip_version=xxx 注：该字段与eips字段一致。 availability_zone_list 否 Array 负载均衡器所在可用区列表。 支持多值查询，查询条件格式： availability_zone_list=xxx&availability_zone_list=xxx。 l4_flavor_id 否 Array 四层Flavor ID。 支持多值查询，查询条件格式：l4_flavor_id=xxx&l4_flavor_id=xxx。 l4_scale_flavor_id 否 Array 四层弹性Flavor ID。 支持多值查询，查询条件格式：l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx。 不支持该字段，请勿使用。 l7_flavor_id 否 Array 七层Flavor ID。 支持多值查询，查询条件格式：l7_flavor_id=xxx&l7_flavor_id=xxx。 l7_scale_flavor_id 否 Array 七层弹性Flavor ID。 支持多值查询，查询条件格式：l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx。 不支持该字段，请勿使用。 billing_info 否 Array 资源账单信息。 支持多值查询，查询条件格式：billing_info=xxx&billing_info=xxx。 member_device_id 否 Array 负载均衡器中的后端云服务器对应的弹性云服务器的ID。仅用于查询条件，不作为响应参数字段。 支持多值查询，查询条件格式：member_device_id=xxx&member_device_id=xxx。 member_address 否 Array 负载均衡器中的后端云服务器对应的弹性云服务器的IP地址。仅用于查询条件，不作为响应参数字段。 支持多值查询，查询条件格式：member_address=xxx&member_address=xxx。 enterprise_project_id 否 Array 负载均衡器所属的企业项目ID。 查询时若不传，则查询default企业项目下的资源，鉴权按照default企业项目鉴权。 如果传值，则必须传已存在的企业项目ID（不可为"0"）或传all_granted_eps表示查询所有企业项目。 支持多值查询，查询条件格式： enterprise_project_id=xxx&enterprise_project_id=xxx。 ip_version 否 Array IP版本信息。 取值：4代表IPv4，6代表IPv6。 支持多值查询，查询条件格式：ip_version=xxx&ip_version=xxx。 deletion_protection_enable 否 Boolean 是否开启删除保护，false不开启，true开启。 elb_virsubnet_type 否 Array 下联面子网类型。 取值： ipv4：ipv4。 dualstack：双栈。 支持多值查询，查询条件格式： elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack。 autoscaling 否 Array 是否开启弹性扩缩容。示例如下： "autoscaling": { "enable": "true" } 支持多值查询，查询条件格式： autoscaling=enable=true&autoscaling=enable=false。 protection_status 否 Array 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 global_eips 否 Array 负载均衡器绑定的公网IP。示例如下： { "global_eips": [ { "global_eip_id": "24000000-0000-0000-0000-100000000001", "global_eip_address": "10.10.10.10", "ip_version": 4 } ] } 支持多值查询，查询条件格式： global_eip_id作为查询条件：global_eips=global_eip_id=xxx&global_eips=global_eip_id=xxx。 global_eip_address作为查询条件：global_eips=global_eip_address=xxx&global_eips=global_eip_address=xxx。 ip_version作为查询条件：global_eips=ip_version=xxx&global_eips=ip_version=xxx。 log_topic_id 否 String LB实例绑定的logtank的topic id信息，支持多值查询，查询条件格式：log_topic_id=xxx&log_topic_id=xxx。 log_group_id 否 String LB实例绑定的logtank的group id信息，支持多值查询，查询条件格式：log_group_id=xxx&log_group_id=xxx。

响应示例 状态码： 200 操作正常返回。 { "request_id" : "88424a61-6fa1-4850-aa8b-ce31d78abcf2", "security_policies" : [ { "id" : "03cf511a-d130-445e-9b02-12d7049ddabf", "name" : "test_security_policy", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "", "protocols" : [ "TLSv1", "TLSv1.3" ], "ciphers" : [ "AES128-SHA", "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ { "id" : "6f7c0d75-81c4-4735-87a0-dc5df0f27f5a" } ], "created_at" : "2021-02-06T10:07:10Z", "updated_at" : "2021-02-06T10:07:10Z" }, { "id" : "04e5d426-628c-42db-867c-fcaefbed2cab", "name" : "update_securitypolicy", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "", "protocols" : [ "TLSv1.2", "TLSv1.1", "TLSv1.3" ], "ciphers" : [ "CAMELLIA128-SHA", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ { "id" : "e19b7379-807e-47fb-b53d-46aff540580c" } ], "created_at" : "2021-02-06T10:01:58Z", "updated_at" : "2021-03-20T07:18:59Z" } ], "page_info" : { "next_marker" : "04e5d426-628c-42db-867c-fcaefbed2cab", "previous_marker" : "03cf511a-d130-445e-9b02-12d7049ddabf", "current_count" : 2 } }

URI GET /v3/{project_id}/elb/security-policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 上一页最后一条记录的ID。 使用说明： 必须与limit一起使用。 不指定时表示查询第一页。 该字段不允许为空或无效的ID。 limit 否 Integer 每页返回的个数。 最小值：0 最大值：2000 缺省值：2000 page_reverse 否 Boolean 是否反向查询。 取值： true：查询上一页。 false：查询下一页，默认。 使用说明： 必须与limit一起使用。 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 id 否 Array 自定义安全策略的ID。 支持多值查询，查询条件格式：id=xxx&id=xxx。 name 否 Array 自定义安全策略的名称。 支持多值查询，查询条件格式：name=xxx&name=xxx。 description 否 Array 自定义安全策略的描述信息。 支持多值查询，查询条件格式：description=xxx&description=xxx。 protocols 否 Array 空格分隔的自定义安全策略的TLS协议。 支持多值查询，查询条件格式：protocols=xxx&protocols=xxx。 ciphers 否 Array 冒号分隔的自定义安全策略的加密套件。 支持多值查询，查询条件格式：ciphers=xxx&ciphers=xxx。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 security_policies Array of SecurityPolicy objects 自定义安全策略列表返回对象。 request_id String 请求ID。 注：自动生成 。 page_info PageInfo object 分页信息。 表5 SecurityPolicy 参数 参数类型 描述 id String 自定义安全安全策略的id。 project_id String 自定义安全策略的项目id。 name String 自定义安全策略的名称 description String 自定义安全策略的描述。 listeners Array of ListenerRef objects 自定义安全策略关联的监听器。 protocols Array of strings 自定义安全策略的TLS协议列表。 ciphers Array of strings 自定义安全策略的加密套件列表。 created_at String 自定义安全策略的创建时间。 updated_at String 自定义安全策略的更新时间。 表6 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表7 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 security_policy SecurityPolicy object 自定义安全策略详情。 request_id String 请求ID。 注：自动生成 。 表4 SecurityPolicy 参数 参数类型 描述 id String 自定义安全安全策略的id。 project_id String 自定义安全策略的项目id。 name String 自定义安全策略的名称 description String 自定义安全策略的描述。 listeners Array of ListenerRef objects 自定义安全策略关联的监听器。 protocols Array of strings 自定义安全策略的TLS协议列表。 ciphers Array of strings 自定义安全策略的加密套件列表。 created_at String 自定义安全策略的创建时间。 updated_at String 自定义安全策略的更新时间。 表5 ListenerRef 参数 参数类型 描述 id String 监听器ID。

响应示例 状态码： 200 操作正常返回。 { "security_policy" : { "id" : "c73e0138-9bdc-40fb-951e-6a1598266ccd", "name" : "update_securitypolicy", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "", "protocols" : [ "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3" ], "ciphers" : [ "AES128-SHA", "AES256-GCM-SHA384", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-SHA", "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ { "id" : "8e92b7c3-cdae-4039-aa62-c76d09a5950a" } ], "created_at" : "2021-03-20T09:48:14Z", "updated_at" : "2021-03-20T12:45:50Z" }, "request_id" : "dab5d1de-c115-4623-b21d-363478fa0af4" }

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 loadbalancer 是 Object 负载均衡器对象。详见表3。 表3 loadbalancer字段说明 参数 是否必选 参数类型 描述 name 否 String 负载均衡器名称。 支持的最大字符长度：255 description 否 String 负载均衡器描述信息。 支持的最大字符长度：255 admin_state_up 否 Boolean 负载均衡器的管理状态。 该字段为预留字段，暂未启用。默认为true。

响应消息 表4 响应参数 参数 参数类型 描述 loadbalancer Object 负载均衡器对象。详见表5。 表5 loadbalancer字段说明 参数 参数类型 描述 id String 负载均衡器ID。 project_id String 此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。 tenant_id String 负载均衡器所在项目的ID。 支持的最大字符长度：255 name String 负载均衡器名称。 支持的最大字符长度：255 description String 负载均衡器的描述信息。 支持的最大字符长度：255 vip_subnet_id String 负载均衡器所在子网IPv4子网ID。 vip_port_id String 负载均衡器内网IP对应的端口ID。 创建弹性负载均衡时，会自动为负载均衡创建一个port并关联一个默认的安全组，这个安全组对所有流量不生效。 provider String 负载均衡器的生产者名称。 vip_address String 负载均衡器的内网IP。 支持的最大字符长度：64 listeners Array 负载均衡器关联监听器ID的列表。详见表5 pools Array 负载均衡器关联后端服务器组ID的列表。详见表6 operating_status String 负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。 provisioning_status String 该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 admin_state_up Boolean 负载均衡器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 tags Array 负载均衡器的标签列表。 created_at String 负载均衡器的创建时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 updated_at String 负载均衡器的更新时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 表6 listeners字段说明 参数 参数类型 描述 id String 关联的监听器id 表7 pools字段说明 参数 参数类型 描述 id String 关联的后端服务器组id

响应示例 响应样例 { "loadbalancer": { "description": "simple lb2", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "provisioning_status": "ACTIVE", "vip_subnet_id": "823d5866-6e30-45c2-9b1a-a1ebc3757fdb", "listeners": [ { "id": "37ffe679-08ef-436e-b6bd-cf66fb4c3de2" } ], "vip_address": "192.172.1.68", "vip_port_id": "f42e3019-67f7-4d2a-8d1c-af49e7c22fa6", "tags": [], "provider": "vlb", "pools": [ { "id": "75c4f2d4-a213-4408-9fa8-d64708e8d1df" } ], "id": "c32a9f9a-0cc6-4f38-bb9c-cde79a533c19", "operating_status": "ONLINE", "name": "loadbalancer-test2", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" } }

请求示例 请求样例 更新负载均衡器名称、描述 PUT https://{Endpoint}/v2.0/lbaas/loadbalancers/1e11b74e-30b7-4b78-b09b-84aec4a04487 { "loadbalancer": { "name": "lb_update_test", "description": "lb update test" } }

响应示例 响应样例 { "l7policy": { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "provisioning_status": "ACTIVE", "action": "REDIRECT_TO_POOL", "position": 1, "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "l7policy-garry-1" } }

响应消息 表2 响应参数 参数 参数类型 描述 l7policy Object 转发策略对象。详见表3。 表3 l7policy字段说明 参数 参数类型 描述 id String 转发策略ID。 tenant_id String 转发策略所在的项目ID。 project_id String 此参数和tenant_id参数含义一样，均指转发策略所在的项目ID。 name String 转发策略名称。 admin_state_up Boolean 转发策略的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 description String 转发策略的描述信息。 listener_id String 转发策略所在的监听器ID。 action String 转发策略的匹配动作。 取值范围： REDIRECT_TO_POOL：将匹配的流量转发到redirect_pool_id指定的后端云服务器组上； REDIRECT_TO_LISTENER：将listener_id指定的HTTP监听器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS监听器上。 redirect_pool_id String 流量匹配后转发到后端云服务器组的ID。 redirect_listener_id String 流量匹配后转发到的监听器的ID。 redirect_url String 转发策略重定向到的url。 该字段为预留字段，暂未启用。 rules Array 转发策略关联的转发规则的ID列表。详见表6 position Integer 转发优先级，从1递增，最高100。默认值：100； 该字段为预留字段，暂未启用。 provisioning_status String 该字段为预留字段，暂未启用。 转发策略的配置状态，可以为ACTIVE。 表4 rules字段说明 参数 参数类型 描述 id String 转发策略关联的转发规则ID

响应示例 响应样例1 { "l7policy": { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "provisioning_status": "ACTIVE", "action": "REDIRECT_TO_POOL", "position": 1, "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "l7policy-garry-1" } }

响应消息 表2 响应参数 参数 参数类型 描述 l7policy L7policy object 转发策略对象。详见表3。 表3 l7policy字段说明 参数 参数类型 描述 id String 转发策略ID。 tenant_id String 转发策略所在的项目ID。 project_id String 此参数和tenant_id参数含义一样，均指转发策略所在的项目ID。 name String 转发策略名称。 admin_state_up Boolean 转发策略的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 description String 转发策略的描述信息。 listener_id String 转发策略所在的监听器ID。 action String 转发策略的匹配动作。 取值范围： REDIRECT_TO_POOL：将匹配的流量转发到redirect_pool_id指定的后端云服务器组上； REDIRECT_TO_LISTENER：将listener_id指定的HTTP监听器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS监听器上。 redirect_pool_id String 流量匹配后转发到后端云服务器组的ID。 redirect_listener_id String 流量匹配后转发到的监听器的ID。 redirect_url String 转发策略重定向到的url。 该字段为预留字段，暂未启用。 rules Array of Rules objects 转发策略关联的转发规则的ID列表。详见表7。 position Integer 转发优先级，从1递增，最高100。默认值：100； 该字段为预留字段，暂未启用。 provisioning_status String 该字段为预留字段，暂未启用。 转发策略的配置状态，可以为ACTIVE。 表4 rules字段说明 参数 参数类型 描述 id String 关联的转发规则id

响应示例 状态码： 200 OK { "request_id" : "5b43d31cd5217ffca57c2c4177e1b1ee", "logtanks" : [ { "project_id" : "060576798a80d5762fafc01a9b5eedc7", "log_topic_id" : "5b9b8370-a1fc-4c59-a509-483a673c8a94", "id" : "281e8768-94f9-45e9-9f3d-9fe2a122ad67", "log_group_id" : "7733882e-f7fa-4fb0-a460-0605c48a2280", "loadbalancer_id" : "995b98d7-6010-4502-a91a-756f399088f8" } ], "page_info" : { "next_marker" : "281e8768-94f9-45e9-9f3d-9fe2a122ad67", "previous_marker" : "281e8768-94f9-45e9-9f3d-9fe2a122ad67", "current_count" : 1 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 logtanks Array of Logtank objects 描述信息 page_info PageInfo object 负载均衡器分页信息。 request_id String 请求ID。 注：自动生成 。 表5 Logtank 参数 参数类型 描述 id String 云日志 ID。 project_id String 项目ID。 loadbalancer_id String 负载均衡器ID。 log_group_id String 云日志分组ID。 log_topic_id String 云日志主题ID。 表6 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。

URI GET /v3/{project_id}/elb/logtanks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页返回的个数。 最小值：0 最大值：2000 缺省值：2000 marker 否 String 上一页最后一条记录的ID。 使用说明： 必须与limit一起使用。 不指定时表示查询第一页。 该字段不允许为空或无效的ID。 page_reverse 否 Boolean 是否反向查询。 取值： true：查询上一页。 false：查询下一页，默认。 使用说明： 必须与limit一起使用。 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker enterprise_project_id 否 Array 企业项目ID。 支持多值查询，查询条件格式：enterprise_project_id=xxx&enterprise_project_id=xxx。 id 否 Array 云日志记录ID。 支持多值查询，查询条件格式：id=xxx&id=xxx。 loadbalancer_id 否 Array 负载均衡器ID。 支持多值查询，查询条件格式：loadbalancer_id=xxx&loadbalancer_id=xxx。 log_group_id 否 Array 云日志分组ID。 支持多值查询，查询条件格式：log_group_id=xxx&log_group_id=xxx。 log_topic_id 否 Array 云日志主题ID 支持多值查询，查询条件格式：log_topic_id=xxx&log_topic_id=xxx。

响应消息 表2 响应参数 参数 参数类型 描述 whitelist Object 白名单对象。详见表3。 表3 whitelist字段说明 参数 参数类型 描述 id String 白名单的ID。 tenant_id String 转发规则所在的项目ID。 支持的最大字符长度：255 listener_id String 白名单关联的监听器ID。 enable_whitelist Boolean 是否开启访问控制开关。 true：打开 false：关闭 whitelist String 白名单IP的字符串。