云服务器内容精选

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注:自动生成 。 pool MasterSlavePool object 后端服务器组对象。 表4 MasterSlavePool 参数 参数类型 描述 description String 后端云服务器组的描述信息。 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 MasterSlaveMember objects 后端云服务器组中的后端云服务器列表。 name String 后端云服务器组的名称。 project_id String 后端云服务器组所在的项目ID。 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。 session_persistence SessionPersistence object 会话持久性对象。 ip_version String 后端云服务器组支持的IP版本。 取值: 共享型:固定为v4; 独享型:取值dualstack、v4、v6。当协议为TCP/UDP时,ip_version为dualstack,表示双栈。 当协议为HTTP时,ip_version为v4。 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不允许指定。 空字符串(""):允许任意类型的后端 enterprise_project_id String 后端服务器组的企业项目ID。无论创建什么企业项目,都在默认企业项目下。 healthmonitor MasterSlaveHealthMonitor object 后端服务器组的健康检查。 any_port_enable Boolean 后端是否开启端口透传,开启后,后端服务器端口与前端监听器端口保持一致。取值:false不开启,true开启,默认false。 说明: 关闭端口透传后,请求会转发给后端服务器protocol_port字段指定端口。 表5 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表6 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表7 MasterSlaveMember 参数 参数类型 描述 id String 后端服务器ID。 name String 后端服务器名称。 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 address String 后端服务器对应的IP地址。 使用说明: 若subnet_cidr_id为空,表示添加跨VPC后端,此时address必须为IPv4地址。 若subnet_cidr_id不为空,表示是一个关联到E CS 的后端服务器。该IP地址可以是IPv4或IPv6。 但必须在subnet_cidr_id对应的子网网段中。且只能指定为关联ECS的主网卡内网IP。 ip_version String 当前后端服务器的IP地址版本,由后端系统自动根据传入的address字段确定。取值:v4、v6。 device_owner String 设备所有者。 取值: 空,表示后端服务器未关联到ECS。 compute:{az_name},表示关联到ECS,其中{az_name}表示ECS所在可用区名。 不支持该字段,请勿使用。 device_id String 关联的ECS ID,为空表示后端服务器未关联到ECS。 不支持该字段,请勿使用。 operating_status String 后端云服务器的健康状态。 取值: ONLINE:后端云服务器正常。 NO_MONITOR:后端云服务器所在的服务器组没有健康检查器。 OFFLINE:后端云服务器关联的ECS服务器不存在或已关机。 member_type String 后端云服务器的类型。 取值: ip:跨VPC的member。 instance:关联到ECS的member。 instance_id String member关联的实例ID。空表示member关联的实例为非真实设备 (如:跨VPC场景) role String 后端服务器的主备状态。 status Array of ListenerMemberInfo objects 后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中,则以该字段中监听器对应的operating_status为准。 若绑定的监听器不在该字段中,则以外层的operating_status为准。 表8 ListenerMemberInfo 参数 参数类型 描述 listener_id String 后端服务器关联的监听器id。 operating_status String 后端云服务器的健康状态。 取值: ONLINE:后端云服务器正常。 NO_MONITOR:后端云服务器所在的服务器组没有健康检查器。 OFFLINE:后端云服务器关联的ECS服务器不存在或已关机或服务异常。 表9 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。 表10 MasterSlaveHealthMonitor 参数 参数类型 描述 admin_state_up Boolean 健康检查的管理状态。 取值: true:表示开启健康检查,默认为true。 false表示关闭健康检查。 delay Integer 健康检查间隔。取值:1-50s。 最小值:1 最大值:50 domain_name String 发送健康检查请求的 域名 。 取值:以数字或字母开头,只能包含数字、字母、’-’、’.’。 默认为空,表示使用负载均衡器的vip作为http请求的目的地址。 使用说明:当type为HTTP/HTTPS时生效。 expected_codes String 期望响应状态码。 取值: 单值:单个返回码,例如200。 列表:多个特定返回码,例如200,202。 区间:一个返回码区间,例如200-204。 默认值:200。 仅支持HTTP/HTTPS设置该字段,其他协议设置不会生效。 http_method String HTTP请求方法。 取值:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH,默认GET。 使用说明:当type为HTTP/HTTPS时生效。 不支持该字段,请勿使用。 id String 健康检查ID max_retries Integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围:1-10。 最小值:1 最大值:10 max_retries_down Integer 健康检查连续失败多少次后,将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围:1-10,默认3。 最小值:1 最大值:10 monitor_port Integer 健康检查端口号。取值:1-65535,默认为空,表示使用后端云服务器端口号。 最小值:1 最大值:65535 name String 健康检查名称。 timeout Integer 一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值:1 最大值:50 type String 健康检查请求协议。 取值:TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明: 若pool的protocol为QUIC,则type只能是UDP_CONNECT。 若pool的protocol为UDP,则type只能UDP_CONNECT。 若pool的protocol为TCP,则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTP,则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTPS,则type可以是TCP、HTTP、HTTPS。 url_path String 健康检查请求的请求路径。以"/"开头,默认为"/"。 支持使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和and(&)以及扩展字符集_;~!()*[]@$^:',+ 使用说明:当type为HTTP/HTTPS时生效。
  • 响应示例 状态码: 200 操作正常返回。 { "pool" : { "lb_algorithm" : "LEAST_CONNECTIONS", "type" : "ip", "vpc_id" : "3sae7086-a416-4666-9064-5b340e6840125", "protocol" : "TCP", "description" : "", "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor" : { "monitor_port" : null, "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "domain_name" : "", "name" : "My Healthmonitor", "max_retries" : 3, "max_retries_down" : 3, "admin_state_up" : true, "type" : "HTTP", "timeout" : 30, "delay" : 1, "http_method" : "get", "url_path" : "/", "expected_codes" : "200" }, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" } ], "members" : [ { "admin_state_up" : true, "address" : "172.16.0.210", "protocol_port" : 80, "id" : "2e7b36d2-66c8-4825-bcd2-211d99978680", "operating_status" : "OFFLINE", "status" : [ ], "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "ip", "role" : "master", "ip_version" : "v4", "name" : "cx-test-master", "subnet_cidr_id" : "" }, { "admin_state_up" : true, "address" : "172.16.0.211", "protocol_port" : 81, "id" : "2e7b36d2-66c8-4823-bsd2-21sa199978681", "operating_status" : "OFFLINE", "status" : [ ], "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "ip", "role" : "slave", "ip_version" : "v4", "name" : "cx-test-slave", "subnet_cidr_id" : "" } ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool", "ip_version" : "dualstack", "created_at" : "2021-03-26T01:33:12Z", "updated_at" : "2021-03-26T01:33:12Z" }, "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e" }