华为云用户手册

请求示例 给负载均衡器新增可用区 POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/9b663cd9-61e4-483d-b91f-92fc337fecec/availability-zone/batch-add { "availability_zone_list" : [ "az2", "az3" ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 loadbalancer LoadBalancer object 负载均衡器对象。 request_id String 请求ID。 注：自动生成 。 最小长度：0 最大长度：36 loadbalancer_id String 负载均衡器ID，仅在创建包周期场景下返回。 order_id String 订单号，仅在创建包周期场景下返回。 表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

响应示例 状态码： 200 操作正常返回。 { "request_id" : "b5d8bb34d28f3e47b352c14419e8fe04", "members" : [ { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.48", "protocol_port" : 8080, "id" : "9346ad28-6971-456a-9711-2917d023930a", "operating_status" : "OFFLINE", "instance_id" : "", "member_type" : "instance", "port_id" : "", "name" : "batch_member1", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398", "ret_status" : "successful" }, { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.49", "protocol_port" : 8080, "id" : "94548801-1023-452f-bcf7-6174e77cb772", "operating_status" : "OFFLINE", "instance_id" : "", "member_type" : "instance", "port_id" : "", "name" : "batch_member2", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398", "ret_status" : "successful" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 members Array of BatchMember objects 后端服务器对象列表。 表6 BatchMember 参数 参数类型 描述 id String 后端服务器ID。 说明： 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 name String 后端服务器名称。 project_id String 后端服务器所在的项目ID。 admin_state_up Boolean 后端云服务器的管理状态。 取值：true、false。 虽然创建、更新请求支持该字段，但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。 subnet_cidr_id String 后端云服务器所在子网的IPv4子网ID或IPv6子网ID。 若所属的LB的跨VPC后端转发特性已开启，则该字段可以不传，表示添加跨VPC的后端服务器。 此时address必须为IPv4地址，所在的pool的协议必须为TCP/HTTP/HTTPS。 使用说明： 该子网和关联的负载均衡器的子网必须在同一VPC下。 protocol_port Integer 后端服务器业务端口。 说明： 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。 最小值：1 最大值：65535 weight Integer 后端云服务器的权重，请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 取值：0-100，默认1。 使用说明： 若所在pool的lb_algorithm取值为SOURCE_IP，该字段无效。 最小值：0 最大值：100 address String 后端服务器对应的IP地址。 使用说明： 若subnet_cidr_id为空，表示添加跨VPC后端，此时address必须为IPv4地址。 若subnet_cidr_id不为空，表示是一个关联到ECS的后端服务器。该IP地址可以是IPv4或IPv6。 但必须在subnet_cidr_id对应的子网网段中。且只能指定为关联ECS的主网卡内网IP。 operating_status String 后端云服务器的健康状态。 取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。 status Array of MemberStatus objects 后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中，则以该字段中监听器对应的operating_stauts为准。 若绑定的监听器不在该字段中，则以外层的operating_status为准。 member_type String 后端云服务器的类型。 取值： ip：跨VPC的member。 instance：关联到ECS的member。 instance_id String member关联的实例ID，空表示跨VPC场景的member。 port_id String IP地址对应的VPC port ID ret_status String 当前后端服务器创建结果状态。 取值： successful：添加成功。 existed：member已存在。 表7 MemberStatus 参数 参数类型 描述 listener_id String 监听器ID operating_status String 后端云服务器的健康状态。 取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。

请求示例 批量创建后端服务器。 POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-add { "members" : [ { "name" : "lzs_batch_member1", "weight" : 1, "address" : "192.168.0.48", "protocol_port" : 8080, "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "name" : "lzs_batch_member2", "weight" : 1, "address" : "192.168.0.49", "protocol_port" : 8080, "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of BatchCreateMembersOption objects 后端服务器对象。 表4 BatchCreateMembersOption 参数 是否必选 参数类型 描述 name 否 String 后端服务器名称。 最小长度：0 最大长度：255 address 是 String 后端云服务器的对应的IP地址，这个IP必须在subnet_cidr_id字段的子网网段中。例如：192.168.3.11。 subnet_cidr_id为空代表添加跨VPC后端，此时address必须为ipv4地址。 最小长度：1 最大长度：64 protocol_port 是 Integer 后端服务器端口号。 最小值：1 最大值：65535 subnet_cidr_id 否 String 后端云服务器所在的子网ID。该子网和后端云服务器关联的负载均衡器的子网必须在同一VPC下。 当所在LB未开启跨VPC后端，该参数必填。 当所在LB开启跨VPC后端，该参数非必填，表示添加跨VPC后端，此时address必须为ipv4地址， pool的协议必须为TCP/HTTP/HTTPS，pool所属的LB的跨VPC后端转发能力必须打开。 最小长度：1 最大长度：36 weight 否 Integer 后端云服务器的权重，请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 取值：0-100，默认1。 使用说明：若所在pool的lb_algorithm取值为SOURCE_IP，该字段无效。 最小值：0 最大值：100

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 pool Pool object 后端服务器组对象。 表8 Pool 参数 参数类型 描述 admin_state_up Boolean 后端云服务器组的管理状态，只支持设置为true。 不支持该字段，请勿使用。 description String 后端云服务器组的描述信息。 healthmonitor_id String 后端云服务器组关联的健康检查的ID。 id String 后端云服务器组的ID。 lb_algorithm String 后端云服务器组的负载均衡算法。 取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。 使用说明： 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 只有pool的protocol为QUIC时，才支持QUIC_CID算法。 listeners Array of ListenerRef objects 后端云服务器组关联的监听器ID列表。 loadbalancers Array of LoadBalancerRef objects 后端云服务器组关联的负载均衡器ID列表。 members Array of MemberRef objects 后端云服务器组中的后端云服务器ID列表。 name String 后端云服务器组的名称。 project_id String 后端云服务器组所在的项目ID。 protocol String 后端云服务器组的后端协议。 取值：TCP、UDP、HTTP、HTTPS、QUIC和TCPSSL。 使用说明： listener的protocol为UDP时，pool的protocol必须为UDP或QUIC； listener的protocol为TCP时pool的protocol必须为TCP； listener的protocol为HTTP时，pool的protocol必须为HTTP。 listener的protocol为HTTPS时，pool的protocol必须为HTTP或HTTPS。 listener的protocol为TERMINATED_HTTPS时，pool的protocol必须为HTTP。 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 session_persistence SessionPersistence object 会话持久性对象。 ip_version String 后端云服务器组支持的IP版本。 取值： 共享型：固定为v4； 独享型：取值dualstack、v4、v6。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。 当协议为HTTP时，ip_version为v4。 slow_start SlowStart object 慢启动信息。开启慢启动后，将会在设定的时间段（duration）内对新添加到后端服务器组的后端服务器进行预热，转发到该服务器的请求数量线性增加。 当后端服务器组的协议为HTTP/HTTPS时有效，其他协议传入该字段将报错。 member_deletion_protection_enable Boolean 是否开启误删保护。 取值：false不开启，true开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 vpc_id String 后端云服务器组关联的虚拟私有云的ID。 type String 后端服务器组的类型。 取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。 空字符串（""）：允许任意类型的后端 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 any_port_enable Boolean 后端是否开启端口透传，开启后，后端服务器端口与前端监听器端口保持一致。取值：false不开启，true开启，默认false。 说明： 关闭端口透传后，请求会转发给后端服务器protocol_port字段指定端口。 表9 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表10 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表11 MemberRef 参数 参数类型 描述 id String 后端服务器ID。 表12 SessionPersistence 参数 参数类型 描述 cookie_name String cookie名称。 共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。 独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。 使用说明： 只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。 type String 会话保持类型。 取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 使用说明： 当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。 当pool的protocol为HTTP、HTTPS时。如果是独享型负载均衡器的pool， 则type只能为HTTP_COOKIE，其他取值会话保持失效。 如果是共享型负载均衡器的pool，则type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 persistence_timeout Integer 会话保持的时间。当type为APP_COOKIE时不生效。 适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1； 如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。 表13 SlowStart 参数 参数类型 描述 enable Boolean 慢启动的开关，默认值：false； true：开启； false：关闭 缺省值：false duration Integer 慢启动的持续时间。取值：30~1200s，默认30s； 最小值：30 最大值：1200 缺省值：30

请求示例 更新后端服务组的负载均衡算法 PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75 { "pool" : { "name" : "My pool.", "description" : "My pool update", "lb_algorithm" : "LEAST_CONNECTIONS" } }

响应示例 状态码： 200 操作正常返回。 { "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "My pool update", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : null, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" }, { "id" : "61942790-2367-482a-8b0e-93840ea2a1c6" }, { "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool.", "ip_version" : "dualstack" }, "request_id" : "8f40128b-c72b-4b64-986a-f7e2c633d75f" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 pool 是 UpdatePoolOption object 后端服务器组对象。 表4 UpdatePoolOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 后端云服务器组的管理状态，只支持更新为true。 description 否 String 后端云服务器组的描述信息。 最小长度：0 最大长度：255 lb_algorithm 否 String 后端云服务器组的负载均衡算法。 取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。 使用说明： 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 只有pool的protocol为QUIC时，才支持QUIC_CID算法。 name 否 String 后端云服务器组的名称。 最小长度：0 最大长度：255 session_persistence 否 UpdatePoolSessionPersistenceOption object 会话持久性对象。 slow_start 否 UpdatePoolSlowStartOption object 慢启动信息。开启慢启动后，将会在设定的时间段（duration）内对新添加到后端服务器组的后端服务器进行预热，转发到该服务器的请求数量线性增加。 当后端服务器组的协议为HTTP/HTTPS时有效，其他协议传入该字段将报错。 member_deletion_protection_enable 否 Boolean 是否开启删除保护。 取值：false不开启，true开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 vpc_id 否 String 后端云服务器组关联的虚拟私有云的ID。 只有vpc_id为空时允许更新。 最小长度：0 最大长度：36 type 否 String 后端服务器组的类型。 取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。 空字符串（""）：允许任意类型的后端 使用说明： 只有type为空时允许更新，不允许从非空更新为空。 protection_status 否 String 修改保护状态, 取值： nonProtection: 不保护 consoleProtection: 控制台修改保护 protection_reason 否 String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 any_port_enable 否 Boolean 后端是否开启端口透传，开启后，后端服务器端口与前端监听器端口保持一致。取值：false不开启，true开启，默认false。 说明： 关闭端口透传后，请求会转发给后端服务器protocol_port字段指定端口。 表5 UpdatePoolSessionPersistenceOption 参数 是否必选 参数类型 描述 cookie_name 否 String cookie名称。 共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。 独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。 使用说明： 只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。 type 否 String 会话保持类型。 取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 使用说明： 当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。 当pool的protocol为HTTP、HTTPS时。如果是独享型负载均衡器的pool， 则type只能为HTTP_COOKIE，其他取值会话保持失效。 如果是共享型负载均衡器的pool，则type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 persistence_timeout 否 Integer 会话保持的时间。当type为APP_COOKIE时不生效。 适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1； 如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。 表6 UpdatePoolSlowStartOption 参数 是否必选 参数类型 描述 enable 否 Boolean 慢启动的开关，默认值：false； true：开启； false：关闭 duration 否 Integer 慢启动的持续时间，单位：s。默认：30； 取值范围：30~1200 最小值：30 最大值：1200

响应示例 状态码： 201 POST操作正常返回。 { "listener" : { "id" : "0b11747a-b139-492f-9692-2df0b1c87193", "name" : "My listener", "protocol_port" : 80, "protocol" : "TCP", "description" : null, "default_tls_container_ref" : null, "admin_state_up" : true, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "client_ca_tls_container_ref" : null, "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "sni_container_refs" : [ ], "connection_limit" : -1, "member_timeout" : null, "client_timeout" : null, "keepalive_timeout" : null, "default_pool_id" : null, "ipgroup" : null, "tls_ciphers_policy" : "tls-1-0", "tags" : [ ], "created_at" : "2019-04-02T00:12:32Z", "updated_at" : "2019-04-02T00:12:32Z", "http2_enable" : false, "enable_member_retry" : true, "insert_headers" : { "X-Forwarded-ELB-IP" : true }, "transparent_client_ip_enable" : false }, "request_id" : "f4c4aca8-df16-42e8-8836-33e4b8e9aa8e" }

请求示例 示例1：创建protocol为TCP的监听器。 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners { "listener" : { "protocol_port" : 80, "protocol" : "TCP", "loadbalancer_id" : "098b2f68-af1c-41a9-8efd-69958722af62", "name" : "My listener", "admin_state_up" : true, "insert_headers" : { "X-Forwarded-ELB-IP" : true } } } 示例2：创建protocol为HTTPS的监听器。 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners { "listener" : { "protocol_port" : 90, "protocol" : "HTTPS", "loadbalancer_id" : "098b2f68-af1c-41a9-8efd-69958722af62", "name" : "My listener", "admin_state_up" : true, "ipgroup" : { "ipgroup_id" : "0416b6f1-877f-4a51-987e-978b3f083542", "type" : "black" }, "security_policy_id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "default_tls_container_ref" : "233a325e5e3e4ce8beeb320aa714cc12" } }

响应参数 状态码： 201 表10 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 listener Listener object 监听器对象。 表11 Listener 参数 参数类型 描述 admin_state_up Boolean 监听器的管理状态。只能设置为true。 不支持该字段，请勿使用。 client_ca_tls_container_ref String 监听器使用的CA证书ID。当且仅当type=client时，才会使用该字段对应的证书。 connection_limit Integer 监听器的最大连接数。 取值：-1表示不限制，默认为-1。 不支持该字段，请勿使用。 created_at String 监听器的创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如：2021-07-30T12:03:44Z default_pool_id String 监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。 default_tls_container_ref String 监听器使用的服务器证书ID。 description String 监听器的描述信息。 http2_enable Boolean 客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后，可提升客户端与LB间的访问性能，但LB与后端服务器间仍采用HTTP1.X协议。 使用说明： 仅HTTPS协议监听器有效。 QUIC监听器不能设置该字段，固定返回为true。 其他协议的监听器可设置该字段但无效，无论取值如何都不影响监听器正常运行。 id String 监听器ID。 insert_headers ListenerInsertHeaders object 可选的HTTP头插入，可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器使。例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。 loadbalancers Array of LoadBalancerRef objects 监听器所属的负载均衡器的ID列表。一个监听器只支持关联到一个LB。 name String 监听器的名称。 注意：若名称为空，则在控制台的监听器列表无法选择并查看监听器详情。 project_id String 监听器所在的项目ID。 protocol String 监听器的监听协议。 取值：TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TCPSSL。 使用说明： 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS， 创建时传入HTTPS将会自动转为TERMINATED_HTTPS。 独享型LB上的HTTPS监听器只支持设置为HTTPS，创建时传入TERMINATED_HTTPS将会自动转为HTTPS。 protocol_port Integer 监听器的监听端口。QUIC监听器端口不能是4789，且不能和UDP监听器端口重复。传0时表示开启监听端口范围的能力，此时port_ranges为必填字段。 最小值：0 最大值：65535 sni_container_refs Array of strings 监听器使用的SNI证书（带域名的服务器证书）ID列表。 使用说明： 列表对应的所有SNI证书的域名不允许存在重复。 列表对应的所有SNI证书的域名总数不超过50。 sni_match_algo String 监听器使用的SNI证书泛域名匹配方式。 longest_suffix表示最长尾缀匹配，wildcard表示标准域名分级匹配。 默认为wildcard。 tags Array of Tag objects 标签列表。 updated_at String 监听器的更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如：2021-07-30T12:03:44Z tls_ciphers_policy String 监听器使用的安全策略。 取值：tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict，tls-1-2-fs，tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0，默认：tls-1-0。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 QUIC监听器不支持该字段。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件（即支持ecc又支持rsa） security_policy_id String 自定义安全策略的ID。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件（即支持ecc又支持rsa） enable_member_retry Boolean 是否开启后端服务器的重试。 取值：true 开启重试，false 不开启重试。默认：true。 使用说明： 若关联是共享型LB，仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 若关联是独享型LB，仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 keepalive_timeout Integer 客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求， 负载均衡会暂时中断当前连接，直到下一次请求时重新建立新的连接。 取值： 若为TCP监听器，取值范围为（10-4000s）默认值为300s。 若为HTTP/HTTPS/TERMINATED_HTTPS监听器，取值范围为（0-4000s）默认值为60s。 UDP监听器不支持此字段。 client_timeout Integer 等待客户端请求超时时间，包括两种情况： 读取整个客户端请求头的超时时长：如果客户端未在超时时长内发送完整个请求头，则请求将被中断 两个连续body体的数据包到达LB的时间间隔，超出client_timeout将会断开连接。 取值范围为1-300s，默认值为60s。 使用说明：仅协议为HTTP/HTTPS的监听器支持该字段。 member_timeout Integer 等待后端服务器响应超时时间。请求转发后端服务器后，在等待超时member_timeout时长没有响应，负载均衡将终止等待，并返回 HTTP504错误码。 取值：1-300s，默认为60s。 使用说明：仅支持协议为HTTP/HTTPS的监听器。 ipgroup ListenerIpGroup object listener对象中的ipgroup信息 transparent_client_ip_enable Boolean 是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 仅作用于共享型LB的TCP/UDP监听器。 取值： 共享型LB的TCP/UDP监听器可设置为true或false，不传默认为false。 共享型LB的HTTP/HTTPS监听器只支持设置为true，不传默认为true。 独享型负载均衡器所有协议的监听器只支持设置为true，不传默认为true。 使用说明： 开启特性后，ELB和后端服务器之间直接使用真实的IP访问，需要确保已正确设置服务器的安全组以及访问控制策略。 开启特性后，不支持同一台服务器既作为后端服务器又作为客户端的场景。 开启特性后，不支持变更后端服务器规格。 proxy_protocol_enable Boolean 是否开启proxy_protocol。仅tcpssl监听器可指定，其他协议的监听器该字段不生效，proxy_protocol不开启。 enhance_l7policy_enable Boolean 是否开启高级转发策略功能。开启高级转发策略后，支持更灵活的转发策略和转发规则设置。 取值：true开启，false不开启，默认false。 开启后支持如下场景： 转发策略的action字段支持指定为REDIRECT_TO_URL, FIXED_RESPONSE，即支持URL重定向和响应固定的内容给客户端。 转发策略支持指定priority、redirect_url_config、fixed_response_config字段。 转发规则rule的type可以指定METHOD, HEADER, QUERY_STRING, SOURCE_IP这几种取值。 转发规则rule的type为HOST_NAME时，转发规则rule的value支持通配符*。 转发规则支持指定conditions字段。 缺省值：false quic_config ListenerQuicConfig object 当前监听器关联的QUIC监听器配置信息，仅protocol为HTTPS时有效。 对于TCP/UDP/HTTP/QUIC监听器，若该字段非空则报错。 说明： 客户端向服务端发送正常的HTTP协议请求并携带了支持QUIC协议的信息。 如果服务端监听器开启了升级QUIC，那么就会在响应头中加入服务端支持的QUIC端口和版本信息。 客户端再次请求时会同时发送TCP(HTTPS)和UDP(QUIC)请求，若QUIC请求成功，则后续继续使用QUIC交互。 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 gzip_enable Boolean ELB是否开启gzip压缩，缺省值：false，非必选 仅HTTP/HTTPS/QUIC类型监听器支持配置。 port_ranges Array of PortRange objects 端口监听范围（闭区间)，最多指定10个端口组，每个组范围不可有重叠部分 说明： 仅当protocol_port为0时可以传入。 ssl_early_data_enable Boolean 监听器0-RTT能力开关，缺省值：false，非必选 仅HTTPS类型监听器支持配置，需要依赖TLSv1.3安全策略协议。 表12 ListenerInsertHeaders 参数 参数类型 描述 X-Forwarded-ELB-IP Boolean X-Forwarded-ELB-IP设为true可以将ELB实例的eip地址从报文的http头中带到后端云服务器。 X-Forwarded-Port Boolean X-Forwarded-Port设为true可以将ELB实例的监听端口从报文的http头中带到后端云服务器。 X-Forwarded-For-Port Boolean X-Forwarded-For-Port设为true可以将客户端的源端口从报文的http头中带到后端云服务器。 X-Forwarded-Host Boolean X-Forwarded-Host设为true可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器。 X-Forwarded-Proto Boolean X-Forwarded-Proto设为true可以将负载均衡器实例的监听协议通过报文的http头带到后端云服务器。 X-Real-IP Boolean X-Real-IP设为true可以将客户端的IP通过报文的http头带到后端云服务器。 X-Forwarded-ELB-ID Boolean X-Forwarded-ELB-ID设为true可以将负载均衡器实例的ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Certificate-ID Boolean X-Forwarded-TLS-Certificate-ID设为true可以将负载均衡器实例的证书ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Protocol Boolean X-Forwarded-TLS-Protocol设为true可以将负载均衡器实例的算法协议通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Cipher Boolean X-Forwarded-TLS-Cipher设为true可以将负载均衡器实例的算法套件通过报文的http头带到后端云服务器。 表13 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表14 Tag 参数 参数类型 描述 key String 标签键 最小长度：1 最大长度：36 value String 标签值 最小长度：0 最大长度：43 表15 ListenerIpGroup 参数 参数类型 描述 ipgroup_id String 监听器关联的访问控制组的id。 创建时必选，更新时非必选。 指定的ipgroup必须已存在，不能指定为null，否则与enable_ipgroup冲突。 enable_ipgroup Boolean 访问控制组的状态。 True:开启访问控制； Flase：关闭访问控制； 开启访问控制的监听器，允许直接删除。 type String 访问控制组的类型。 white:白名单，只允许指定ip访问； black:黑名单，不允许指定ip访问； 表16 ListenerQuicConfig 参数 参数类型 描述 quic_listener_id String 监听器关联的QUIC监听器ID。 创建时必选，更新时非必选。 指定的listener id必须已存在，且协议类型为QUIC，不能指定为null，否则与enable_quic_upgrade冲突。 enable_quic_upgrade Boolean QUIC升级的开启状态。 True:开启QUIC升级； Flase：关闭QUIC升级； 开启HTTPS监听器升级QUIC监听器能力 表17 PortRange 参数 参数类型 描述 start_port Integer 起始端口 最小值：1 最大值：65535 end_port Integer 结束端口，需大于等于起始端口 最小值：1 最大值：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 listener 是 CreateListenerOption object 监听器对象。 表4 CreateListenerOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 监听器的管理状态。固定为true。 不支持该字段，请勿使用。 default_pool_id 否 String 监听器默认的后端云服务器组ID。当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。 最小长度：1 最大长度：36 client_ca_tls_container_ref 否 String 监听器使用的CA证书ID。当且仅当type=client时，才会使用该字段对应的证书。 监听器协议为QUIC时不支持该字段。 最小长度：1 最大长度：128 default_tls_container_ref 否 String 监听器使用的服务器证书ID。 使用说明：当监听器协议为HTTPS时，该字段必传，且对应的证书的type必须是server类型。 最小长度：1 最大长度：128 description 否 String 监听器的描述信息。 最小长度：0 最大长度：255 http2_enable 否 Boolean 客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后，可提升客户端与LB间的访问性能，但LB与后端服务器间仍采用HTTP1.X协议。 使用说明： 仅HTTPS协议监听器有效。 QUIC监听器不能设置该字段，固定返回为true。 其他协议的监听器可设置该字段但无效，无论取值如何都不影响监听器正常运行。 insert_headers 否 ListenerInsertHeaders object 可选的HTTP头插入，可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器使。例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。 loadbalancer_id 是 String 监听器所属的负载均衡器的ID列表。 使用说明： 一个监听器只支持关联到一个LB。 最小长度：1 最大长度：36 name 否 String 监听器的名称。 注意：若名称为空，则在控制台的监听器列表无法选择并查看监听器详情。 最小长度：0 最大长度：255 project_id 否 String 监听器所在的项目ID。 最小长度：1 最大长度：32 protocol 是 String 监听器的监听协议。 取值：TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TCPSSL。 使用说明： 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS。 传入HTTPS将会自动转为TERMINATED_HTTPS。 独享型LB上的HTTPS监听器只支持设置为HTTPS，传入TERMINATED_HTTPS将会自动转为HTTPS。 required: false protocol_port 否 Integer 监听器的监听端口。QUIC监听器端口不能是4789，且不能和UDP监听器端口重复。传0时表示开启监听端口范围的能力，此时port_ranges为必填字段。 最小值：0 最大值：65535 sni_container_refs 否 Array of strings 监听器使用的SNI证书（带域名的服务器证书）ID列表。 使用说明： 列表对应的所有SNI证书的域名不允许存在重复。 列表对应的所有SNI证书的域名总数不超过50。 QUIC监听器仅支持RSA证书。 数组长度：0 - 50 sni_match_algo 否 String 监听器使用的SNI证书泛域名匹配方式。 longest_suffix表示最长尾缀匹配，wildcard表示标准域名分级匹配。 默认为wildcard。 tags 否 Array of Tag objects 标签列表 tls_ciphers_policy 否 String 监听器使用的安全策略。 取值：tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict，tls-1-2-fs，tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0，默认：tls-1-0。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 QUIC监听器不支持该字段。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件（即支持ecc又支持rsa） security_policy_id 否 String 自定义安全策略的ID。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 QUIC监听器不支持该字段。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件 （即支持ecc又支持rsa） 最小长度：1 最大长度：36 enable_member_retry 否 Boolean 是否开启后端服务器的重试。 取值：true 开启重试，false 不开启重试。默认：true。 使用说明： 若关联是共享型LB，仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 若关联是独享型LB，仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 keepalive_timeout 否 Integer 客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求， 负载均衡会暂时中断当前连接，直到下一次请求时重新建立新的连接。 取值： 若为TCP监听器，取值范围为（10-4000s）默认值为300s。 若为HTTP/HTTPS/TERMINATED_HTTPS监听器，取值范围为（0-4000s）默认值为60s。 UDP监听器不支持此字段。 client_timeout 否 Integer 等待客户端请求超时时间，包括两种情况： 读取整个客户端请求头的超时时长：如果客户端未在超时时长内发送完整个请求头，则请求将被中断 两个连续body体的数据包到达LB的时间间隔，超出client_timeout将会断开连接。 取值范围为1-300s，默认值为60s。 使用说明：仅协议为HTTP/HTTPS的监听器支持该字段。 最小值：1 最大值：300 缺省值：60 member_timeout 否 Integer 等待后端服务器响应超时时间。请求转发后端服务器后，在等待超时member_timeout时长没有响应，负载均衡将终止等待，并返回 HTTP504错误码。 取值：1-300s，默认为60s。 使用说明：仅支持协议为HTTP/HTTPS的监听器。 最小值：1 最大值：300 缺省值：60 ipgroup 否 CreateListenerIpGroupOption object 监听器对象中的控制组（ipgroup）信息，可以不传或传null或{}，表示监听器不绑定访问控制组。 若需要绑定访问控制组，则ipgroup_id是必须的。 transparent_client_ip_enable 否 Boolean 是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 仅作用于共享型LB的TCP/UDP监听器。 取值： 共享型LB的TCP/UDP监听器可设置为true或false，不传默认为false。 共享型LB的HTTP/HTTPS监听器只支持设置为true，不传默认为true。 独享型负载均衡器所有协议的监听器只支持设置为true，不传默认为true。 使用说明： 开启特性后，ELB和后端服务器之间直接使用真实的IP访问，需要确保已正确设置服务器的安全组以及访问控制策略。 开启特性后，不支持同一台服务器既作为后端服务器又作为客户端的场景。 开启特性后，不支持变更后端服务器规格。 proxy_protocol_enable 否 Boolean 是否开启proxy_protocol。仅tcpssl监听器可指定，其他协议的监听器该字段不生效，proxy_protocol不开启。 enhance_l7policy_enable 否 Boolean 是否开启高级转发策略功能。开启高级转发策略后，支持更灵活的转发策略和转发规则设置。 取值：true开启，false不开启，默认false。 开启后支持如下场景： 转发策略的action字段支持指定为REDIRECT_TO_URL, FIXED_RESPONSE，即支持URL重定向和响应固定的内容给客户端。 转发策略支持指定priority、redirect_url_config、fixed_response_config字段。 转发规则rule的type可以指定METHOD, HEADER, QUERY_STRING, SOURCE_IP这几种取值。 转发规则rule的type为HOST_NAME时，转发规则rule的value支持通配符*。 转发规则支持指定conditions字段。 说明： 开启后不支持关闭 quic_config 否 CreateListenerQuicConfigOption object 当前监听器关联的QUIC监听器配置信息，仅protocol为HTTPS时有效。 对于TCP/UDP/HTTP/QUIC监听器，若该字段非空则报错。 说明： 客户端向服务端发送正常的HTTP协议请求并携带了支持QUIC协议的信息。 如果服务端监听器开启了升级QUIC，那么就会在响应头中加入服务端支持的QUIC端口和版本信息。 客户端再次请求时会同时发送TCP(HTTPS)和UDP(QUIC)请求，若QUIC请求成功，则后续继续使用QUIC交互。 protection_status 否 String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason 否 String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 gzip_enable 否 Boolean ELB是否开启gzip压缩，缺省值：false，非必选 仅HTTP/HTTPS/QUIC类型监听器支持配置。 port_ranges 否 Array of PortRange objects 端口监听范围（闭区间)，最多指定10个端口组，每个组范围不可有重叠部分 说明： 仅当protocol_port为0或未传入protoco_port时可以传入该字段。仅TCP, UDP，TCPSSL监听支持该字段 数组长度：1 - 20 ssl_early_data_enable 否 Boolean 监听器0-RTT能力开关，缺省值：false，非必选 仅HTTPS类型监听器支持配置，需要依赖TLSv1.3安全策略协议。开启 ssl_early_data 后，有重放攻击的风险，请谨慎开启。 缺省值：false 表5 ListenerInsertHeaders 参数 是否必选 参数类型 描述 X-Forwarded-ELB-IP 否 Boolean X-Forwarded-ELB-IP设为true可以将ELB实例的eip地址从报文的http头中带到后端云服务器。 X-Forwarded-Port 否 Boolean X-Forwarded-Port设为true可以将ELB实例的监听端口从报文的http头中带到后端云服务器。 X-Forwarded-For-Port 否 Boolean X-Forwarded-For-Port设为true可以将客户端的源端口从报文的http头中带到后端云服务器。 X-Forwarded-Host 否 Boolean X-Forwarded-Host设为true可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器。 X-Forwarded-Proto 否 Boolean X-Forwarded-Proto设为true可以将负载均衡器实例的监听协议通过报文的http头带到后端云服务器。 X-Real-IP 否 Boolean X-Real-IP设为true可以将客户端的IP通过报文的http头带到后端云服务器。 X-Forwarded-ELB-ID 否 Boolean X-Forwarded-ELB-ID设为true可以将负载均衡器实例的ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Certificate-ID 否 Boolean X-Forwarded-TLS-Certificate-ID设为true可以将负载均衡器实例的证书ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Protocol 否 Boolean X-Forwarded-TLS-Protocol设为true可以将负载均衡器实例的算法协议通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Cipher 否 Boolean X-Forwarded-TLS-Cipher设为true可以将负载均衡器实例的算法套件通过报文的http头带到后端云服务器。 表6 Tag 参数 是否必选 参数类型 描述 key 否 String 标签键 最小长度：1 最大长度：36 value 否 String 标签值 最小长度：0 最大长度：43 表7 CreateListenerIpGroupOption 参数 是否必选 参数类型 描述 ipgroup_id 是 String 监听器关联的访问控制组的id。 当关联的ipgroup中的ip_list为[]，且类型为白名单时，表示禁止所有ip的访问。 当关联的ipgroup中的ip_list为[]，且类型为黑名单时，表示允许所有ip的访问。 最小长度：1 最大长度：36 enable_ipgroup 否 Boolean 访问控制组的状态。 取值： true：开启访问控制，默认值。 flase：关闭访问控制。 type 否 String 访问控制组的类型。 white：白名单，只允许指定ip访问，默认值。 black：黑名单，不允许指定ip访问。 表8 CreateListenerQuicConfigOption 参数 是否必选 参数类型 描述 quic_listener_id 是 String 监听器关联的QUIC监听器ID。指定的listener id必须已存在，且协议类型为QUIC，不能指定为null，否则与enable_quic_upgrade冲突。 enable_quic_upgrade 否 Boolean QUIC升级的开启状态。 True:开启QUIC升级； Flase：关闭QUIC升级（默认）。 开启HTTPS监听器升级QUIC监听器能力。 缺省值：false 表9 PortRange 参数 是否必选 参数类型 描述 start_port 否 Integer 起始端口 最小值：1 最大值：65535 end_port 否 Integer 结束端口，需大于等于起始端口 最小值：1 最大值：65535

操作步骤 请按照下列步骤逐个删除负载均衡器关联的资源后再删除负载均衡器。如果没有配置关联的资源，则跳过相应的步骤，例如未配置健康检查，则跳过1。 删除关联的监听器下的后端服务器组的健康检查器。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/healthmonitors/{healthmonitor_id}”，project_id为项目ID，healthmonitor_id为健康检查器ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 移除关联的监听器下的后端服务器组的所有服务器。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/pools/{pool_id}/members/{member_id}”，project_id为项目ID，pool_id为服务器组ID，member_id为服务器器ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 删除关联的监听器下的所有后端服务器组。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/pools/{pool_id}”，project_id为项目ID，pool_id为服务器组ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 删除关联的监听器下的所有转发策略的转发规则。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/l7policies/{policy_id}/rules/{rule_id}”，project_id为项目ID，policy_id为转发策略ID，rule_id为转发规则ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 删除关联的监听器下的所有转发策略。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/l7policies/{policy_id}”，project_id为项目ID，policy_id为转发策略ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 删除负载均衡器关联的监听器。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elb/listeners/{listener_id}”，project_id为项目ID，listener_id为监听器ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。 删除负载均衡器。 发送“DELETE https://{elb_endpoint}/v3/{project_id}/elbloadbalancers/{loadbalancer_id}”，project_id为项目ID，loadbalancer_id为负载均衡器ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，返回HTTP STATUS = 204，空body体。 请求异常时，错误码请参见 错误码。

响应参数 表3 响应参数 参数 参数类型 描述 tags Array 标签列表。详见表4。 表4 tags 字段数据结构说明 参数 参数类型 描述 key String 标签名称。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 标签值。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。

响应示例 状态码： 200 操作正常返回。 { "rule" : { "compare_type" : "STARTS_WITH", "provisioning_status" : "ACTIVE", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "invert" : false, "admin_state_up" : true, "value" : "/ccc.html", "key" : null, "type" : "PATH", "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7" }, "request_id" : "133096f9-e754-430d-a2c2-e61fe1190aa8" }

请求示例 更新转发规则 PUT https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7 { "rule" : { "compare_type" : "STARTS_WITH", "value" : "/ccc.html" } }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 rule L7Rule object 规则对象。 表7 L7Rule 参数 参数类型 描述 admin_state_up Boolean 转发规则的管理状，默认为true。 不支持该字段，请勿使用。 compare_type String 转发规则的匹配方式。type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX， STARTS_WITH，EQUAL_TO。 key String 匹配内容的键值。type为HOST_NAME和PATH时，该字段不生效。 最小长度：1 最大长度：255 project_id String 转发规则所在的项目ID。 type String 转发规则类别。 取值： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 使用说明： 一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。 value String 匹配内容的值。仅当conditions空时该字段生效。 当type为HOST_NAME时，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头。 若域名中包含*，则只能出现在开头且必须以.开始。当*开头时表示通配0~任一个字符。 当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当type为METHOD、SOURCE_IP、HEADER, QUERY_STRING时，该字段无意义，使用condition_pair来指定key，value。 最小长度：1 最大长度：128 provisioning_status String provisioning状态，可以为ACTIVE、PENDING_CREATE 或者ERROR。 说明：该字段无实际含义，默认为ACTIVE。 invert Boolean 是否反向匹配。 使用说明：固定为false。该字段能更新但不会生效。 id String 规则ID。 conditions Array of RuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。 若转发规则配置了conditions，字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同，value不允许重复。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 表8 RuleCondition 参数 参数类型 描述 key String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度：1 最大长度：128 value String 匹配项的值。 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-.*， 必须以字母、数字或*开头，*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以"/"开头。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格， 双引号，支持以下通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符） 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 rule 是 UpdateL7RuleOption object 规则对象。 表4 UpdateL7RuleOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 转发规则的管理状态，默认为true。 不支持该字段，请勿使用。 compare_type 否 String 转发匹配方式。 取值： EQUAL_TO 表示精确匹配。 REGEX 表示正则匹配。 STARTS_WITH 表示前缀匹配。 使用说明： type为HOST_NAME时仅支持EQUAL_TO，支持通配符*。 type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。 type为METHOD、SOURCE_IP时，仅支持EQUAL_TO。 type为HEADER、QUERY_STRING，仅支持EQUAL_TO，支持通配符*、？。 invert 否 Boolean 是否反向匹配。 取值：true、false。 不支持该字段，请勿使用。 key 否 String 匹配项的名称，比如转发规则匹配类型是请求头匹配，则key表示请求头参数的名称。 不支持该字段，请勿使用。 最小长度：0 最大长度：255 value 否 String 匹配项的值。比如转发规则匹配类型是域名匹配，则value表示域名的值。仅当conditions空时该字段生效。 当转发规则类别type为HOST_NAME时，字符串只能包含英文字母、数字、-.*，必须以字母、数字或*开头。 若域名中包含*，则*只能出现在开头且必须以*.开始。当*开头时表示通配0~任一个字符。 当转发规则类别type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当转发规则类别type为METHOD、SOURCE_IP、HEADER,QUERY_STRING时， 该字段无意义，使用conditions来指定key/value。 最小长度：1 最大长度：128 conditions 否 Array of UpdateRuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。 若转发规则配置了conditions，字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同，value不允许重复。 表5 UpdateRuleCondition 参数 是否必选 参数类型 描述 key 否 String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度：1 最大长度：128 value 否 String 匹配项的值。 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-.*， 必须以字母、数字或*开头，*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格， 双引号，支持以下通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符） 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度：1 最大长度：128

请求示例 请求样例1 全量查询SSL证书 GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/certificates 请求样例2 过滤查询id为ef4d341365754a959556576501791b19或ed40e8ea9957488ea82de025e35b74c0的SSL证书 GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/certificates ?id=ef4d341365754a959556576501791b19&id=ed40e8ea9957488ea82de025e35b74c0

响应示例 响应样例1 { "certificates": [ { "certificate": "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----", "create_time": "2017-02-25 09:35:27", "expire_time": "2045-11-17 13:25:47", "description": "description for certificate", "domain": "www.elb.com", "id": "23ef9aad4ecb463580476d324a6c71af", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "name": "https_certificate", "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----", "type": "server", "update_time": "2017-02-25 09:35:27" } ], "instance_num": 1 } 响应样例2 { "certificates": [ { "description": "Push by SSL Certificate Manager", "domain": null, "id": "ed40e8ea9957488ea82de025e35b74c0", "name": "certForSonar9", "certificate": "-----BEGIN CERTIFICATE----- MIIFizCCBHOgAwIBAgIQBlQycV3bWsVsCttvv5rgRjANBgkqhkiG9w0BAQsFADBu MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 d3cuZGlnaWNlcnQuY29tMS0wKwYDVQQDEyRFbmNyeXB0aW9uIEV2ZXJ5d2hlcmUg RFYgVExTIENBIC0gRzEwHhcNMTgwNzEwMDAwMDAwWhcNMTkwNzEwMTIwMDAwWjAU MRIwEAYDVQQDEwlpY2UxMjMudGswggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQCtTDlQMoAvyInR6X1dihhNwbdGesbMW6NZX7ffpj9XrB3KCqqlxzI4VmH9 PntvrpLJNeolgLqDZZc4zKbUkmqxY1dvGDs41coKzdtc9Ig23GVK48wfesnk5r50 afyU52R1JlSHDOhiDhHOSyhrOzc2GreLrByWKFUaAue6rTnyMbzQaSPtrTAqsURZ wcmJ6R3A6JwokOgxXBSu41ufPQiFkMgxygKxEBLzIJLjRqCXQHYoxbsTyolb6jwp w4H6vcRIEcFAgs98ApWRoEKjy7eOP3UUm05F+OkOvXhrlxEqIPm/rlwE0PmVlmm9 DgBafYb3xT/MtT2VRSfCJQHgIcsdAgMBAAGjggJ9MIICeTAfBgNVHSMEGDAWgBRV dE+yck/1YLpQ0dfmUVyaAYca1zAdBgNVHQ4EFgQUEFavzYXBNbIHBchbaKcUKad+ qCEwIwYDVR0RBBwwGoIJaWNlMTIzLnRrgg13d3cuaWNlMTIzLnRrMA4GA1UdDwEB /wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwTAYDVR0gBEUw QzA3BglghkgBhv1sAQIwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNl cnQuY29tL0NQUzAIBgZngQwBAgEwgYEGCCsGAQUFBwEBBHUwczAlBggrBgEFBQcw AYYZaHR0cDovL29jc3AyLmRpZ2ljZXJ0LmNvbTBKBggrBgEFBQcwAoY+aHR0cDov L2NhY2VydHMuZGlnaWNlcnQuY29tL0VuY3J5cHRpb25FdmVyeXdoZXJlRFZUTFND QS1HMS5jcnQwCQYDVR0TBAIwADCCAQQGCisGAQQB1nkCBAIEgfUEgfIA8AB2AKS5 CZC0GFgUh7sTosxncAo8NZgE+RvfuON3zQ7IDdwQAAABZIOnLCIAAAQDAEcwRQIh AJX6gCXNggPdfOFdDtZPzlYr64TTrR/+b9QKKhyJ2EjBAiAWgu3BG2QK9tWQXpUN IFadc0nvqmDovabg5nmRMan2mQB2AId1v+dZfPiMQ5lfvfNu/1aNR1Y2/0q1YMG0 6v9eoIMPAAABZIOnLQEAAAQDAEcwRQIhAJVRe/7n88dD6KdhNrd4LdFjGARQNmta Y/K2dFDOXPSfAiBOLrWW8unHOL25RWHJU7Ost3XkNhQYtrLDJrnzo/9kZzANBgkq hkiG9w0BAQsFAAOCAQEAeqtX9cHmj4OnNAk0IGmF3nKS/u/UgGsY4EJfXwQY2bTZ PCkqxQOA6HEx59vJ+UilTojrNDi0WskRm/8SKBHtmRwzwX3ile8KiR6fFfQhPUtV XHZcTfAFo47c7axqon8vumMlEv1PxVImivQ446K7z3kGm34dhMYxS4Gz2gTl8IKt 90OegejuhbAs5Wlvp1BK8HlYIb5+mw+cgkUC9KTALs5qVbWzogb0bS20KaYarGcu otcZAOMeJdBFWnpzhr1fxmjaNY4u4hrgPZSTU/iBjdHapoza3zAFfxysmGYqs9dR jFyxZeR4scz8GqSTFviNdH9jvtDJkdAC5hfMaB811Q== -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIEqjCCA5KgAwIBAgIQAnmsRYvBskWr+YBTzSybsTANBgkqhkiG9w0BAQsFADBh MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD QTAeFw0xNzExMjcxMjQ2MTBaFw0yNzExMjcxMjQ2MTBaMG4xCzAJBgNVBAYTAlVT MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j b20xLTArBgNVBAMTJEVuY3J5cHRpb24gRXZlcnl3aGVyZSBEViBUTFMgQ0EgLSBH MTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALPeP6wkab41dyQh6mKc oHqt3jRIxW5MDvf9QyiOR7VfFwK656es0UFiIb74N9pRntzF1UgYzDGu3ppZVMdo lbxhm6dWS9OK/lFehKNT0OYI9aqk6F+U7cA6jxSC+iDBPXwdF4rs3KRyp3aQn6pj pp1yr7IB6Y4zv72Ee/PlZ/6rK6InC6WpK0nPVOYR7n9iDuPe1E4IxUMBH/T33+3h yuH3dvfgiWUOUkjdpMbyxX+XNle5uEIiyBsi4IvbcTCh8ruifCIi5mDXkZrnMT8n wfYCV6v6kDdXkbgGRLKsR4pucbJtbKqIkUGxuZI2t7pfewKRc5nWecvDBZf3+p1M pA8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRVdE+yck/1YLpQ0dfmUVyaAYca1zAf BgNVHSMEGDAWgBQD3lA1VtFMu2bwo+IbG8OXsj3RVTAOBgNVHQ8BAf8EBAMCAYYw HQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMBIGA1UdEwEB/wQIMAYBAf8C AQAwNAYIKwYBBQUHAQEEKDAmMCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC5kaWdp Y2VydC5jb20wQgYDVR0fBDswOTA3oDWgM4YxaHR0cDovL2NybDMuZGlnaWNlcnQu Y29tL0RpZ2lDZXJ0R2xvYmFsUm9vdENBLmNybDBMBgNVHSAERTBDMDcGCWCGSAGG /WwBAjAqMCgGCCsGAQUFBwIBFhxodHRwczovL3d3dy5kaWdpY2VydC5jb20vQ1BT MAgGBmeBDAECATANBgkqhkiG9w0BAQsFAAOCAQEAK3Gp6/aGq7aBZsxf/oQ+TD/B SwW3AU4ETK+GQf2kFzYZkby5SFrHdPomunx2HBzViUchGoofGgg7gHW0W3MlQAXW M0r5LUvStcr82QDWYNPaUy4taCQmyaJ+VB+6wxHstSigOlSNF2a6vg4rgexixeiV 4YSB03Yqp2t3TeZHM9ESfkus74nQyW7pRGezj+TC44xCagCQQOzzNmzEAP2SnCrJ sNE2DpRVMnL8J6xBRdjmOsC3N6cQuKuRXbzByVBjCqAA8t1L0I+9wXJerLPyErjy rMKWaBFLmfK/AHNF4ZihwPGOc7w6UHczBZXH5RFzJNnww+WnKuTPI0HfnVH8lg== -----END CERTIFICATE-----", "type": "server", "create_time": "2019-03-03 16:32:30", "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEArUw5UDKAL8iJ0el9XYoYTcG3RnrGzFujWV+336Y/V6wdygqq pccyOFZh/T57b66SyTXqJYC6g2WXOMym1JJqsWNXbxg7ONXKCs3bXPSINtxlSuPM H3rJ5Oa+dGn8lOdkdSZUhwzoYg4Rzksoazs3Nhq3i6wclihVGgLnuq058jG80Gkj 7a0wKrFEWcHJiekdwOicKJDoMVwUruNbnz0IhZDIMcoCsRAS8yCS40agl0B2KMW7 E8qJW+o8KcOB+r3ESBHBQILPfAKVkaBCo8u3jj91FJtORfjpDr14a5cRKiD5v65c BND5lZZpvQ4AWn2G98U/zLU9lUUnwiUB4CHLHQIDAQABAoIBAGs5rISompP2OwA8 virwVRVXdPUQ5oxvbuTPys+A59RxVIU8kFW+qJ4fJMYysOFrXLtOtq+5tK20YBru 1ZLVfVqAowrELXB/J2ID+WTMkLORLsNlq1kW+nC9LL6PDY98lLW/n7FoFSkGl5HT AxFGNGUvpr2vIojuL6nGfmcM47uscJ9aP6IJxr4p70dhPVjZBdnMnXYwRkB3dZt/ E0B/p8J5i3oo5Rucv4DOfB+01wXGAVyx5/zce+NZdhyrivkj3hHV55SxGhVWzWhj a3dAlbpKwYgfILj0inRdJYmIjBdbGb2HFix7+ncBg8B2oerJXC6/fANwRGu5/LZU 5xuPVWkCgYEA6an8TY1unIGLYL5aBJ16Tx4usqMyTXr/T4zkQyftRPMt+ZuxVQHl GHsg7XvLFNd04MBZXtkZXaYVcpOm7OUYcl0i9ZAkWXXoXcBtn1Oom3gz/7RjAUnp k+myvxCUSQ2JSz4u3QBtyPVyYNyBFXrKqdKfcYyG85+yQVHBNMVrdvMCgYEAvd0C hFpm83ha+VQp+9XN1DYZNUyqhibj/E3X9jAn+gDbzlKxw/D9en2RIlQYUrl8+il8 QKk4cfOxJYStQfxptz8QBPVeLajDN67zJ0Rk8AB50HHHcNSU8uFkaO8KxsyVjbLS +JltqfJAEraXLinbp1Fxcg9DsQdMd6cw2DmrWa8CgYEA1UjJOUzo80i4HYWDC4Vn OEK3o22do+WqmEVlsfsG9BH5HEdGVe7V3EO/6aY+1/ZXBDPvH8mRAs9v8lbeXow7 hWCIYZfB5jre8HyOU4l8dPUCmdxhJrL913rRIuASSqBlet32ztnuXCnWzp1X4nBj /yF3UqFQKZ7SihcDAZVWo4sCgYEAj7al/BcNzIcynX2mldhdh583b4/Ll+YCNm2Z 5eDHscZKmx8fLcjRpZE8dXagPqXmwtj6E1vDvQWP9m06VDNCthFHB+nO0tLmidSk evmbScuiaTRmmbJf2IThY0hlqNsc7PgKF2DTkIstEr0hLDFE8Z6FN6f0PiDfMcbd Ax6L5EMCgYEA0+qhuQftKQkGdbXX9r3H8N0TVh27ByfL3kKVYy0dUJMvsOAq6d97 8mEhYhrYt88f1sFsPM7G09XpCcBXwiKxw8+CDt9auD4r1snBnILpqMPmanF4UDXH L7s+4it+nIQy24P6g1PihtzsM+HD2UCErBiYUJdRK8Q9GGHdZojFk9Y= -----END RSA PRIVATE KEY----- ", "update_time": "2019-03-03 16:32:30", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "expire_time": "2019-07-10 12:00:00" }, { "description": null, "domain": "www.elb.com", "id": "ef4d341365754a959556576501791b19", "name": "certificate_28b824c8bbee419992fb7974b2911c72", "certificate": "-----BEGIN CERTIFICATE----- MIIDpTCCAo2gAwIBAgIJAKdmmOBYnFvoMA0GCSqGSIb3DQEBCwUAMGkxCzAJBgNV BAYTAnh4MQswCQYDVQQIDAJ4eDELMAkGA1UEBwwCeHgxCzAJBgNVBAoMAnh4MQsw CQYDVQQLDAJ4eDELMAkGA1UEAwwCeHgxGTAXBgkqhkiG9w0BCQEWCnh4QDE2My5j b20wHhcNMTcxMjA0MDM0MjQ5WhcNMjAxMjAzMDM0MjQ5WjBpMQswCQYDVQQGEwJ4 eDELMAkGA1UECAwCeHgxCzAJBgNVBAcMAnh4MQswCQYDVQQKDAJ4eDELMAkGA1UE CwwCeHgxCzAJBgNVBAMMAnh4MRkwFwYJKoZIhvcNAQkBFgp4eEAxNjMuY29tMIIB IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwZ5UJULAjWr7p6FVwGRQRjFN 2s8tZ/6LC3X82fajpVsYqF1xqEuUDndDXVD09E4u83MS6HO6a3bIVQDp6/klnYld iE6Vp8HH5BSKaCWKVg8lGWg1UM9wZFnlryi14KgmpIFmcu9nA8yV/6MZAe6RSDmb 3iyNBmiZ8aZhGw2pI1YwR+15MVqFFGB+7ExkziROi7L8CFCyCezK2/oOOvQsH1dz Q8z1JXWdg8/9Zx7Ktvgwu5PQM3cJtSHX6iBPOkMU8Z8TugLlTqQXKZOEgwajwvQ5 mf2DPkVgM08XAgaLJcLigwD513koAdtJd5v+9irw+5LAuO3JclqwTvwy7u/YwwID AQABo1AwTjAdBgNVHQ4EFgQUo5A2tIu+bcUfvGTD7wmEkhXKFjcwHwYDVR0jBBgw FoAUo5A2tIu+bcUfvGTD7wmEkhXKFjcwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0B AQsFAAOCAQEAWJ2rS6Mvlqk3GfEpboezx2J3X7l1z8Sxoqg6ntwB+rezvK3mc9H0 83qcVeUcoH+0A0lSHyFN4FvRQL6X1hEheHarYwJK4agb231vb5erasuGO463eYEG r4SfTuOm7SyiV2xxbaBKrXJtpBp4WLL/s+LF+nklKjaOxkmxUX0sM4CTA7uFJypY c8Tdr8lDDNqoUtMD8BrUCJi+7lmMXRcC3Qi3oZJW76ja+kZA5mKVFPd1ATih8TbA i34R7EQDtFeiSvBdeKRsPp8c0KT8H1B4lXNkkCQs2WX5p4lm99+ZtLD4glw8x6Ic i1YhgnQbn5E0hz55OLu5jvOkKQjPCW+8Kg== -----END CERTIFICATE-----", "type": "server", "create_time": "2018-09-28 03:00:47", "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwZ5UJULAjWr7p6FVwGRQRjFN2s8tZ/6LC3X82fajpVsYqF1x qEuUDndDXVD09E4u83MS6HO6a3bIVQDp6/klnYldiE6Vp8HH5BSKaCWKVg8lGWg1 UM9wZFnlryi14KgmpIFmcu9nA8yV/6MZAe6RSDmb3iyNBmiZ8aZhGw2pI1YwR+15 MVqFFGB+7ExkziROi7L8CFCyCezK2/oOOvQsH1dzQ8z1JXWdg8/9Zx7Ktvgwu5PQ M3cJtSHX6iBPOkMU8Z8TugLlTqQXKZOEgwajwvQ5mf2DPkVgM08XAgaLJcLigwD5 13koAdtJd5v+9irw+5LAuO3JclqwTvwy7u/YwwIDAQABAoIBACU9S5fjD9/jTMXA DRs08A+gGgZUxLn0xk+NAPX3LyB1tfdkCaFB8BccLzO6h3KZuwQOBPv6jkdvEDbx Nwyw3eA/9GJsIvKiHc0rejdvyPymaw9I8MA7NbXHaJrY7KpqDQyk6sx+aUTcy5jg iMXLWdwXYHhJ/1HVOo603oZyiS6HZeYU089NDUcX+1SJi3e5Ke0gPVXEqCq1O11/ rh24bMxnwZo4PKBWdcMBN5Zf/4ij9vrZE+fFzW7vGBO48A5lvZxWU2U5t/OZQRtN 1uLOHmMFa0FIF2aWbTVfwdUWAFsvAOkHj9VV8BXOUwKOUuEktdkfAlvrxmsFrO/H yDeYYPkCgYEA/S55CBbR0sMXpSZ56uRn8JHApZJhgkgvYr+FqDlJq/e92nAzf01P RoEBUajwrnf1ycevN/SDfbtWzq2XJGqhWdJmtpO16b7KBsC6BdRcH6dnOYh31jgA vABMIP3wzI4zSVTyxRE8LDuboytF1mSCeV5tHYPQTZNwrplDnLQhywcCgYEAw8Yc Uk/eiFr3hfH/ZohMfV5p82Qp7DNIGRzw8YtVG/3+vNXrAXW1VhugNhQY6L+zLtJC aKn84ooup0m3YCg0hvINqJuvzfsuzQgtjTXyaE0cEwsjUusOmiuj09vVx/3U7siK Hdjd2ICPCvQ6Q8tdi8jV320gMs05AtaBkZdsiWUCgYEAtLw4Kk4f+xTKDFsrLUNf 75wcqhWVBiwBp7yQ7UX4EYsJPKZcHMRTk0EEcAbpyaJZE3I44vjp5ReXIHNLMfPs uvI34J4Rfot0LN3n7cFrAi2+wpNo+MOBwrNzpRmijGP2uKKrq4JiMjFbKV/6utGF Up7VxfwS904JYpqGaZctiIECgYA1A6nZtF0riY6ry/uAdXpZHL8ONNqRZtWoT0kD 79otSVu5ISiRbaGcXsDExC52oKrSDAgFtbqQUiEOFg09UcXfoR6HwRkba2CiDwve yHQLQI5Qrdxz8Mk0gIrNrSM4FAmcW9vi9z4kCbQyoC5C+4gqeUlJRpDIkQBWP2Y4 2ct/bQKBgHv8qCsQTZphOxc31BJPa2xVhuv18cEU3XLUrVfUZ/1f43JhLp7gynS2 ep++LKUi9D0VGXY8bqvfJjbECoCeu85vl8NpCXwe/LoVoIn+7KaVIZMwqoGMfgNl nEqm7HWkNxHhf8A6En/IjleuddS1sf9e/x+TJN1Xhnt9W6pe7Fk1 -----END RSA PRIVATE KEY-----", "update_time": "2018-09-28 03:00:47", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "expire_time": "2020-12-03 03:42:49" } ], "instance_num": 2 }

响应消息 表3 响应参数 参数 参数类型 描述 certificates Array of Certificates objects SSL证书对象列表。详见表4。 instance_num Integer 证书的个数。 表4 certificates响应参数 参数 参数类型 描述 id String SSL证书ID。 tenant_id String SSL证书所在的项目ID。 支持的最大字符长度：255 admin_state_up Boolean SSL证书的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 name String SSL证书名称。 支持的最大字符长度：255 description String 证书描述SSL证书描述。 支持的最大字符长度：255 type String SSL证书的类型。 取值范围： server：服务端证书； client：客户端证书； domain String 服务端证书所签域名。 支持的最大字符长度：100 private_key String PEM格式的服务端私有密钥。 certificate String PEM格式的服务端公有密钥或者用于认证客户端证书的CA证书，由type字段区分。 expire_time String SSL证书的过期时间。 格式为UTC时间：YYYY-MM-DD HH:MM:SS create_time String SSL证书的创建时间。 格式为UTC时间：YYYY-MM-DD HH:MM:SS update_time String SSL证书的更新时间。 格式为UTC时间：YYYY-MM-DD HH:MM:SS

URI GET /v2/{project_id}/elb/certificates 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 表2 请求参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的SSL证书的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的SSL证书的个数。如果不设置，则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 id 否 String SSL证书ID。 name 否 String SSL证书的名称。 支持的最大字符长度：255 description 否 String 证书描述SSL证书描述。 支持的最大字符长度：255 type 否 String SSL证书的类型。默认值：server； 取值范围： server：服务端证书； client：客户端证书； domain 否 String 服务端证书所签的域名。默认值：null； 支持的最大字符长度：100 取值范围： 普通域名由若干字符串组成，总长度为0-100，字符串间以"."分割，单个字符串长度不超过63个字符，只能包含英文字母、数字或"-"，且必须以字母或数字开头和结尾。 泛域名在普通域名的基础上仅允许首字母为"*"。该字段仅type为server时有效。 private_key 否 String HTTPS协议使用的私钥，PEM编码格式。 当type为client时，该参数被忽略，不影响证书的创建和使用。且若不符合格式，则该字段会设置为空。 当type为server时，该字段必须符合格式要求，且私钥必须是有效的，否则会报错。 certificate 否 String PEM格式的服务端公有密钥或者用于认证客户端证书的CA证书，由type字段区分。 create_time 否 String SSL证书的创建时间。 格式为UTC时间：YYYY-MM-DD HH:MM:SS update_time 否 String SSL证书的更新时间。 格式为UTC时间：YYYY-MM-DD HH:MM:SS

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求示例 添加云服务器请求样例 可以查询云服务器所属负载均衡器的vip_subnet_id及弹性云服务器的ip地址，得到subnet_id、ip_address； 或根据弹性云服务器id查询对应的subnet_id和address(GET https://{VPCEndpoint}/v2.0/ports?device_id={device_id})，其中device_id为弹性云服务器的id。取响应体中主网卡（primary_interface为true的port）的subnet_id、ip_address。 POST https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members { "member": { "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "protocol_port": 88, "name": "member-jy-tt-1", "address": "192.168.44.11" } }

响应示例 响应样例 { "member": { "name": "member-jy-tt-1", "weight": 1, "admin_state_up": true, "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "address": "192.168.44.11", "protocol_port": 88, "operating_status": "ONLINE", "id": "c0042496-e220-44f6-914b-e6ca33bab503" } }