华为云用户手册

  • 状态码 表1 正常状态码 正常返回码 类型 说明 200 OK GET和PUT操作正常返回。 201 Created POST操作正常返回。 204 No Content DELETE操作正常返回。 表2 错误状态码 错误返回码 类型 可能的错误原因 400 Bad request 请求URI不正确 请求的header超过长度限制 请求体不正确 请求体中包含未上线的特性字段 401 Unauthorized 请求的header中未携带鉴权信息 请求的header中携带的鉴权信息已过期 403 Forbidden 用户无访问API的权限 404 Not Found 请求的URI不存在 请求的资源不存在 405 Method Not Allowed 请求中指定的方法不被允许 406 Not Acceptable 服务器生成的响应无法被客户端所接受 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 Request Timeout 请求超出了服务器的等待时间 409 Conflict 由于冲突,请求无法被完成 请求的资源正在被其他请求处理 500 Internal server error 服务内部错误 服务端异常 501 Not Implemented 请求未完成。服务器不支持所请求的功能 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应 503 Service unavailable 请求未完成。系统暂时异常 504 Gateway Timeout 网关超时 父主题: 附录
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 ipgroup IpGroup object 查询IP地址组详情的响应体。 request_id String 请求ID。 注:自动生成 。 表4 IpGroup 参数 参数类型 描述 created_at String IP地址组的创建时间。 description String IP地址组的描述信息。 id String IP地址组的ID。 ip_list Array of IpInfo objects IP地址组中包含的IP或网段列表。[]表示任意IP。 数组长度:0 - 300 listeners Array of ListenerRef objects 与IP地址组关联的监听器的ID列表。 name String IP地址组的名称。 project_id String IP地址组的项目ID。 updated_at String IP地址组的更新时间。 表5 IpInfo 参数 参数类型 描述 ip String IP地址组中的IP地址。 description String IP地址组中ip的备注信息 最小长度:0 最大长度:255 表6 ListenerRef 参数 参数类型 描述 id String 监听器ID。
  • 响应示例 状态码: 200 操作正常返回 { "ipgroup" : { "description" : "", "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "name" : "test_ipg", "project_id" : "45977fa2dbd7482098dd68d0d8970117", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ], "listeners" : [ { "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "created_at" : "2018-01-16T03:19:16", "updated_at" : "2018-01-16T03:19:16" } }
  • URI DELETE /v2/{project_id}/elb/pools/{pool_id}/members/{member_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 pool_id 是 String 后端云服务器组id。 member_id 是 String 后端云服务器id。 说明: 此处并非服务器的ID,而是ELB添加后端服服务器之后自动生成的member ID。 memberID可以通过查询后端云服务器列表接口获取。
  • 监听器 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 创建listener POST /v2/{project_id}/elb/listeners elb:listeners:create √ √ 查询listener GET /v2/{project_id}/elb/listeners/{listener_id} elb:listeners:get √ √ 查询listener列表 GET /v2/{project_id}/elb/listeners elb:listeners:list √ √ 更新listener PUT /v2/{project_id}/elb/listeners/{listener_id} elb:listeners:put √ √ 删除listener DELETE /v2/{project_id}/elb/listeners/{listener_id} elb:listeners:delete √ √ 父主题: V2API授权项列表
  • 响应消息 表4 响应参数 参数 参数类型 描述 healthmonitor Object 健康检查对象。详见表5。 表5 healthmonitor字段说明 参数 参数类型 描述 id String 健康检查ID。 tenant_id String 健康检查所在的项目ID。 project_id String 此参数和tenant_id参数含义一样,均指健康检查所在的项目ID。 name String 健康检查名称。 delay Integer 健康检查间隔,单位秒,取值范围[1,50]。 max_retries Integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由OFFLINE判定为ONLINE,取值范围[1,10]。 max_retries_down Integer 健康检查连续失败多少次后,将后端服务器的健康检查状态由ONLINE判定为OFFLINE,取值范围[1,10]。 pools Array 健康检查关联的后端云服务器组的ID列表。详见表5 admin_state_up Boolean 健康检查的管理状态。 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 timeout Integer 健康检查超时时间,单位秒,取值范围[1,50]。 说明: 建议该值小于delay的值。 type String 健康检查的类型。 取值范围:TCP、UDP_CONNECT、HTTP。 健康检查的type与其关联的后端云服务器组的protocol有如下关系: 后端云服务器组的protocol为UDP时,健康检查的type只能为UDP_CONNECT; 后端云服务器组的protocol为TCP时,健康检查的type可以为TCP、HTTP; 后端云服务器组的protocol为HTTP时,健康检查的type可以为TCP、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时生效。 说明: 该字段为预留字段,暂未启用。 表6 pools字段说明 参数 参数类型 描述 id String 关联的后端服务器组id
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 healthmonitor 是 Object 健康检查对象。详见表3。 表3 healthmonitor字段说明 参数 是否必选 参数类型 描述 name 否 String 健康检查名称。 支持的最大字符长度:255 delay 否 Integer 健康检查间隔,单位秒,取值范围[1,50]。 max_retries 否 Integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由OFFLINE判定为ONLINE,取值范围[1,10]。 max_retries_down 否 Integer 健康检查连续失败多少次后,将后端服务器的健康检查状态由ONLINE判定为OFFLINE,取值范围[1,10]。 admin_state_up 否 Boolean 健康检查的管理状态。 该字段为预留字段,暂未启用。默认为true。 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时生效。 domain_name 否 String 健康检查时,发送的http请求的域名。 仅当type为HTTP时生效。 默认为空,表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头,只能包含数字、字母、’-’、’.’。 例如:www.test.com 支持的最大字符长度:100 url_path 否 String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如:“/test” 支持的最大字符长度:80 http_method 否 String HTTP请求的方法;默认值:GET 取值范围:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明: 该字段为预留字段,暂未启用。
  • 响应示例 响应样例 { "healthmonitor": { "name": "health-xx", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "domain_name": null, "delay": 15, "expected_codes": "200", "max_retries": 10, "max_retries_down": 5, "http_method": "GET", "timeout": 12, "pools": [ { "id": "bb44bffb-05d9-412c-9d9c-b189d9e14193" } ], "url_path": "/", "type": "HTTP", "id": "2dca3867-98c5-4cde-8f2c-b89ae6bd7e36", "monitor_port": 112 } }
  • 响应参数 表3 响应参数 参数 参数类型 描述 tags Array 标签对象列表。详见表4。 表4 tags 字段数据结构说明 参数 参数类型 描述 key String 键。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 values Array 标签值列表。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。
  • 响应示例 响应样例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ] }
  • 响应示例 状态码: 201 POST操作正常返回。 { "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "", "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" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool", "ip_version" : "v4", "slow_start" : null }, "request_id" : "2d974978-0733-404d-a21a-b29204f4803a" }
  • 请求示例 创建一个后端服务器组,并指定协议为TCP协议 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools { "pool" : { "name" : "My pool", "lb_algorithm" : "LEAST_CONNECTIONS", "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "protocol" : "TCP", "member_deletion_protection_enable" : false } } 创建一个后端服务器组,并指定协议为HTTP协议 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools { "pool" : { "name" : "My pool", "lb_algorithm" : "LEAST_CONNECTIONS", "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "protocol" : "HTTP", "slow_start" : { "enable" : true, "duration" : 50 }, "member_deletion_protection_enable" : false } }
  • 响应参数 状态码: 201 表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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 pool 是 CreatePoolOption object 创建pool的请求体。 表4 CreatePoolOption 参数 是否必选 参数类型 描述 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算法。 listener_id 否 String 后端云服务器组关联的监听器的ID。 使用说明: listener_id,loadbalancer_id,type至少指定一个。 共享型实例的后端服务器组loadbalancer_id和listener_id至少指定一个。 最小长度:1 最大长度:36 loadbalancer_id 否 String 后端云服务器组关联的负载均衡器ID。 使用说明: listener_id,loadbalancer_id,type至少指定一个。 共享型实例的后端服务器组loadbalancer_id和listener_id至少指定一个。 最小长度:1 最大长度:36 name 否 String 后端云服务器组的名称。 最小长度:0 最大长度:255 project_id 否 String 后端云服务器组所属的项目ID。 最小长度:32 最大长度:32 protocol 是 String 后端云服务器组的后端协议。 取值:TCP、UDP、HTTP、HTTPS和QUIC。 使用说明: 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。 最小长度:1 最大长度:255 session_persistence 否 CreatePoolSessionPersistenceOption object 会话持久性对象。 slow_start 否 CreatePoolSlowStartOption object 慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 当后端服务器组的协议为HTTP/HTTPS时有效,其他协议传入该字段将报错。 member_deletion_protection_enable 否 Boolean 是否开启删除保护。 取值:false不开启,true开启,默认false。 说明: 退场时需要先关闭所有资源的删除保护开关。 vpc_id 否 String 后端云服务器组关联的虚拟私有云的ID。 使用说明: 只能挂载到该虚拟私有云下。 只能添加该虚拟私有云下的后端服务器或跨VPC的后端服务器。 type必须指定为instance。 没有指定vpc_id的约束: 后续添加后端服务器时,vpc_id由后端服务器所在的虚拟私有云确定。 最小长度:0 最大长度:36 type 否 String 后端服务器组的类型。 取值: instance:允许任意类型的后端,type指定为该类型时,vpc_id是必选字段。 ip:只能添加跨VPC后端,type指定为该类型时,vpc_id不允许指定。 使用说明: 不传表示允许任意类型的后端,并返回type为空字符串。 listener_id,loadbalancer_id,type至少指定一个。 共享型实例的后端服务器组loadbalancer_id和listener_id至少指定一个。 最小长度:0 最大长度:36 ip_version 否 String 后端云服务器组支持的IP版本。 取值: 共享型:固定为v4; 独享型:取值dualstack、v4、v6。当协议为TCP/UDP时,ip_version为dualstack,表示双栈。 当协议为HTTP时,ip_version为v4。 最小长度:1 最大长度:20 protection_status 否 String 修改保护状态, 取值: nonProtection: 不保护,默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason 否 String 设置保护的原因 说明: 仅当protection_status为consoleProtection时有效。 最小长度:0 最大长度:255 any_port_enable 否 Boolean 后端是否开启端口透传,开启后,后端服务器端口与前端监听器端口保持一致。 使用说明: 仅QUIC,TCP,UDP的pool支持。 表5 CreatePoolSessionPersistenceOption 参数 是否必选 参数类型 描述 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则范围为[1,60](分钟),默认值1; 如果pool的protocol为HTTP和HTTPS则范围为[1,1440](分钟),默认值1440。 表6 CreatePoolSlowStartOption 参数 是否必选 参数类型 描述 enable 否 Boolean 慢启动的开关,默认值:false; true:开启; false:关闭 缺省值:false duration 否 Integer 慢启动的持续时间,单位:s。默认:30; 取值范围:30~1200 最小值:30 最大值:1200 缺省值:30
  • 请求示例 移除负载均衡器的可用区 POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/9b663cd9-61e4-483d-b91f-92fc337fecec/availability-zone/batch-remove { "availability_zone_list" : [ "az2", "az3" ] }
  • 响应示例 状态码: 200 POST操作正常返回。 示例 1 { "request_id" : "6c63d0ac-7beb-451d-a3e0-a066beaea316", "loadbalancer" : { "id" : "9b663cd9-61e4-483d-b91f-92fc337fecec", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ ], "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", "protection_status" : "nonProtection", "protection_reason" : "" } } 示例 2
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 loadbalancer LoadBalancer object 负载均衡器对象。 request_id String 请求ID。 注:自动生成 。 最小长度:0 最大长度:36 表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
  • 请求示例 请求样例1 创建TCP类型的监听器 POST https://{Endpoint}/v2.0/lbaas/listeners { "listener": { "protocol_port": 80, "protocol": "TCP", "loadbalancer_id": "0416b6f1-877f-4a51-987e-978b3f084253", "name": "listener-test", "admin_state_up": true } }
  • 响应消息 表5 响应参数 参数 参数类型 描述 listener Object 监听器对象。详见表6。 表6 listeners字段说明 参数 参数类型 描述 id String 监听器ID。 tenant_id String 监听器所在的项目ID。 project_id String 此参数和tenant_id参数含义一样,均指监听器所在的项目ID。 name String 监听器名称。 description String 监听器描述信息。 protocol String 监听器的监听协议。 支持TCP、HTTP、UDP、TERMINATED_HTTPS。 protocol_port Integer 监听器的监听端口。 取值范围:[1, 65535]。 loadbalancers Array 监听器关联的负载均衡器 ID。详见表7。 connection_limit Integer 监听器的最大连接数。 取值范围:[-1, 2147483647]。默认为-1,无连接数限制。 该字段为预留字段,暂未启动。 admin_state_up Boolean 监听器的管理状态。 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 http2_enable Boolean HTTP2功能的开启状态。 取值范围:true/false。true:开启。false:关闭。 仅针对监听器的协议为TERMINATED_HTTPS有意义。 default_pool_id String 监听器的默认后端云服务器组ID。 当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。当该字段为null时,表示监听器无默认的后端云服务器组。 default_tls_container_ref String 监听器使用的服务器证书ID。详细参见SSL证书管理。 当protocol参数为TERMINATED_HTTPS时,为必选字段。 client_ca_tls_container_ref String 监听器使用的CA证书ID。详细参见SSL证书管理。 sni_container_refs Array 监听器使用的SNI证书(带域名的服务器证书)ID的列表。 该字段不为空列表时,SNI特性开启。该字段为空列表时,SNI特性关闭。 tags Array 监听器的标签。 created_at String 监听器的创建时间。YYYY-MM-DDTHH:MM:SS updated_at String 监听器的更新时间。YYYY-MM-DDTHH:MM:SS insert_headers Object HTTP扩展头部,内部字段全量同步,不选则为默认值。 可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中,随报文传递到后端云服务器上。 例如可通过X-Forwarded-ELB-IP开关,将负载均衡器的弹性公网IP传到后端云服务器。详细参见表8。 仅当监听器的协议为HTTP、TERMINATED_HTTPS时,该字段有意义。 tls_ciphers_policy String 监听器使用的安全策略,仅对TERMINATED_HTTPS协议类型的监听器有效,且默认值为tls-1-0。 取值包括:tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表4。 表7 loadbalancers字段说明 参数 参数类型 描述 id String 关联的负载均衡器id 表8 insert_headers字段说明 参数 参数类型 描述 X-Forwarded-ELB-IP Boolean 负载均衡器弹性公网IP透传开关。打开时可以将负载均衡器的弹性公网IP从报文的HTTP头中带到后端云服务器。 取值范围:true/false。true:开启。false:关闭。 默认:关闭。 X-Forwarded-Host Boolean 负载均衡器X-Forwarded-Host重写开关。打开时可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器 取值范围:true/false。true:开启。false:关闭。 默认:开启。
  • 响应示例 响应样例1 { "listener": { "protocol_port": 80, "protocol": "TCP", "description": "", "client_ca_tls_container_ref": null, "default_tls_container_ref": null, "admin_state_up": true, "http2_enable": false, "loadbalancers": [ { "id": "0416b6f1-877f-4a51-987e-978b3f084253" } ], "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "sni_container_refs": [], "connection_limit": -1, "default_pool_id": null, "tags": [], "id": "b7f32b52-6f17-4b16-9ec8-063d71b653ce", "name": "listener-test", "insert_headers":{}, "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" } }
  • 请求消息 表1 请求参数 参数 是否必选 参数类型 描述 listener 是 Object listener对象。详见表2。 表2 listener字段说明 参数 是否必选 参数类型 描述 tenant_id 否 String 监听器所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度:255 project_id 否 String 此参数和tenant_id参数含义一样,均指监听器所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 name 否 String 监听器名称。 支持的最大字符长度:255 description 否 String 监听器描述信息。 支持的最大字符长度:255 protocol 是 String 监听器的监听协议。 取值范围:TCP、HTTP、UDP、TERMINATED_HTTPS。 protocol_port 是 Integer 监听器的监听端口。 取值范围:[1, 65535]。 说明: 如果监听协议为UDP,端口号不支持4789。 loadbalancer_id 是 String 监听器关联的负载均衡器 ID。 connection_limit 否 Integer 监听器的最大连接数。 取值范围:[-1, 2147483647]。默认为-1,无限制。 该字段为预留字段,暂未启动。 admin_state_up 否 Boolean 监听器的管理状态。 该字段为预留字段,暂未启用。默认为true。 http2_enable 否 Boolean HTTP2功能的开启状态。 取值范围:true/false。true:开启。false:关闭。 默认为false。 仅针对监听器的协议为TERMINATED_HTTPS有意义。 default_pool_id 否 String 监听器的默认后端云服务器组ID。 当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。当该字段为null时,表示监听器无默认的后端云服务器组。 default_pool_id有如下限制: 不能更新为其他监听器的default_pool。 不能更新为其他监听器关联的转发策略所使用的pool。 监听器和与之绑定的后端云服务器的对应关系如下: 监听器的protocol为TCP时,后端云服务器组的protocol必须为TCP。 监听器的protocol为UDP时,后端云服务器组的protocol必须为UDP。 监听器的protocol为HTTP或TERMINATED_HTTPS时,后端云服务器组的protocol必须为HTTP。 default_tls_container_ref 否 String 监听器使用的服务器证书ID。详细参见SSL证书管理。 当protocol参数为TERMINATED_HTTPS时,为必选字段。 当protocol参数为非TERMINATED_HTTPS时,默认值:null。 支持的最大字符长度:128 说明: 仅当监听器的protocol参数为TERMINATED_HTTPS时,该字段有意义。 client_ca_tls_container_ref 否 String 监听器使用的CA证书ID。详细参见SSL证书管理。 默认值:null 支持的最大字符长度:128 说明: 仅当监听器的protocol参数为TERMINATED_HTTPS时,该字段有意义。 sni_container_refs 否 Array 监听器使用的SNI证书(带域名的服务器证书)ID的列表。 该字段不为空列表时,SNI特性开启。该字段为空列表时,SNI特性关闭。 默认值:[] 说明: 仅当监听器的protocol参数为TERMINATED_HTTPS时,该字段有意义。 insert_headers 否 Object HTTP扩展头部,内部字段全量同步,不选则为默认值。 可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中,随报文传递到后端云服务器上。 例如可通过X-Forwarded-ELB-IP开关,将负载均衡器的弹性公网IP传到后端云服务器。详细参见表3。 说明: 仅当监听器的协议为HTTP、TERMINATED_HTTPS时,该字段有意义。 tls_ciphers_policy 否 String 监听器使用的安全策略,仅对TERMINATED_HTTPS协议类型的监听器有效,且默认值为tls-1-0。 取值包括:tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表4。 表3 insert_headers字段说明 参数 是否必选 参数类型 描述 X-Forwarded-ELB-IP 否 Boolean 负载均衡器弹性公网IP透传开关。打开时可以将负载均衡器的弹性公网IP从报文的HTTP头中带到后端云服务器。 取值范围:true/false。true:开启。false:关闭。 默认:关闭。 X-Forwarded-Host 否 Boolean 负载均衡器X-Forwarded-Host重写开关。打开时可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器 取值范围:true/false。true:开启。false:关闭。 默认:开启。 表4 tls_ciphers_policy取值说明 安全策略 支持的TLS版本类型 使用的加密套件列表 tls-1-0-inherit TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA tls-1-0 TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA tls-1-1 TLS 1.2 TLS 1.1 tls-1-2 TLS 1.2 tls-1-2-strict TLS 1.2 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384
  • 响应示例 响应样例1 { "healthmonitor": { "name": "", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "domain_name": "www.test.com", "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": "2dca3867-98c5-4cde-8f2c-b89ae6bd7e36", "monitor_port": 112 } }
  • 响应消息 表4 响应参数 参数 参数类型 描述 healthmonitor Healthmonitor object 健康检查对象。详见表5。 表5 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时生效。 说明: 该字段为预留字段,暂未启用。 表6 pools字段说明 参数 是否必选 参数类型 描述 id 是 String 后端服务器组id
  • 请求示例 请求样例1 创建健康检查 POST https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/healthmonitors { "healthmonitor": { "admin_state_up": true, "pool_id": "bb44bffb-05d9-412c-9d9c-b189d9e14193", "domain_name": "www.test.com", "delay": 10, "max_retries": 10, "timeout": 10, "type": "HTTP" } }
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 healthmonitor 是 Healthmonitor object 健康检查对象。详见表3。 表3 healthmonitor字段说明 参数 是否必选 参数类型 描述 tenant_id 否 String 健康检查所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度:255 name 否 String 健康检查名称。 支持的最大字符长度:255 delay 是 Integer 健康检查的间隔,单位秒,取值范围[1,50]。 max_retries 是 Integer 健康检查最大重试次数,取值范围[1,10]。 pool_id 是 String 健康检查关联的后端云服务器组ID。 每个后端云服务器组只能有一个健康检查。 admin_state_up 否 Boolean 健康检查的管理状态。 该字段为预留字段,暂未启用。默认为true。 timeout 是 Integer 健康检查超时时间,单位秒,取值范围[1,50]。 说明: 建议该值小于delay的值。 type 是 String 健康检查的类型。 取值范围:TCP、UDP_CONNECT、HTTP。 monitor_port 否 Integer 健康检查端口号,取值范围[1,65535]。 默认为空,表示使用后端云服务器的protocol_port作为健康检查的检查端口。 domain_name 否 String 健康检查时,发送的http请求的域名。 仅当type为HTTP时生效。 默认为空,表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头,只能包含数字、字母、’-’、’.’。 例如:www.test.com 支持的最大字符长度:100 url_path 否 String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如:“/test” 支持的最大字符长度:80 expected_codes 否 String 期望HTTP响应状态码,指定下列值: 单值,例如200; 列表,例如200,202; 区间,例如200-204。 仅当type为HTTP时生效。 支持的最大字符长度:64 说明: 该字段为预留字段,暂未启用。 http_method 否 String HTTP请求的方法;默认值:GET 取值范围:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明: 该字段为预留字段,暂未启用。
  • 响应示例 响应样例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/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0G CS qGSIb3DQEBCwUA\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 otcZ AOM eJdBFWnpzhr1fxmjaNY4u4hrgPZSTU/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 }
  • 请求消息 表1 请求参数 参数 是否必选 参数类型 描述 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
  • 响应消息 表2 响应参数 参数 参数类型 描述 certificates Array SSL证书对象列表。详见表3。 instance_num Integer 证书的个数。 表3 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
  • 请求示例 请求样例1 全量查询SSL证书 GET https://{Endpoint}/v2.0/lbaas/certificates 请求样例2 过滤查询id为ef4d341365754a959556576501791b19或ed40e8ea9957488ea82de025e35b74c0的SSL证书 GET https://{Endpoint}/v2.0/lbaas/certificates?id=ef4d341365754a959556576501791b19&id=ed40e8ea9957488ea82de025e35b74c0
  • 响应示例 状态码: 200 操作正常返回。 { "l7policy" : { "redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240", "description" : "", "admin_state_up" : true, "rules" : [ { "id" : "c5c2d625-676b-431e-a4c7-c59cc2664881" } ], "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56", "redirect_url" : null, "redirect_url_config" : null, "fixed_response_config" : null, "redirect_listener_id" : null, "action" : "REDIRECT_TO_POOL", "position" : 100, "priority" : 1, "provisioning_status" : "ACTIVE", "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307", "name" : "l7policy-67" }, "request_id" : "6be83ec4-623e-4840-a417-2fcdf8ad5dfa" }
共100000条