附录
更新时间:2025-08-22
Model对象定义
BLBModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| blbId | String | LoadBalancer的标识符 | 
| name | String | LoadBalancer的名称 | 
| desc | String | LoadBalancer的描述 | 
| address | String | 分配的内网服务地址IP,通过这个IP即能通过内网访问该实例 | 
| status | blbStatus | BLB状态 | 
| vpcId | String | vpc 的ID | 
| subnetId | String | subnet 的ID | 
| publicIp | String | 如果LoadBalancer绑定过EIP,则显示该项,否则不显示 | 
| tags | List<TagModel> | 标签键值对列表 | 
| allowDelete | Boolean | 是否允许删除 | 
| eipRouteType | String | EIP线路类型 | 
| publicIpv6 | String | 如果LoadBalancer绑定过EIPv6,则显示该项,否则不显示 | 
| eipV6RouteType | String | EIPV6线路类型 | 
| paymentTiming | String | 计费方式 取值:"Postpaid" 后付费 "Prepaid" 预付费 | 
| billingMethod | String | 计费方式 取值:"ByCapacityUnit" 按使用量 "BySpec" 按固定规格 | 
TCPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接数、"Hash"代表根据源ip哈希 | 
| healthCheckTimeoutInSecond | int | 健康检查超时 | 
| healthCheckInterval | int | 健康检查间隔 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| tcpSessionTimeout | int | tcp设置连接超时时间(单位:秒),默认为900,需为10-4000间的整数 | 
UDPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接数、"Hash"代表根据源ip哈希 | 
| healthCheckType | String | 健康检查协议,值为"UDP"/"ICMP" | 
| healthCheckPort | int | 健康检查端口,当健康检查协议为"UDP"时可使用 | 
| healthCheckTimeoutInSecond | int | 健康检查超时 | 
| healthCheckInterval | int | 健康检查间隔 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| healthCheckString | String | 健康发送的请求字符串,后端服务器收到后需要进行应答,支持标准转义如\00、\xf2,方便配置二进制格式请求 | 
| udpSessionTimeout | int | udp会话超时时间。默认为90,需为5-4000间的整数,单位秒 | 
HTTPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection" | 
| keepSession | bool | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite" | 
| keepSessionDuration | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardFor | bool | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| additionalAttributes | AdditionalAttributesModel | HTTP类型监听器定制配置 | 
| healthCheckType | String | 健康检查协议,值为"HTTP"/"TCP" | 
| healthCheckPort | int | 健康检查端口 | 
| healthCheckURI | String | 健康检查URI | 
| healthCheckTimeoutInSecond | int | 健康检查超时 | 
| healthCheckInterval | int | 健康检查间隔 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| healthCheckNormalStatus | String | 健康检查正常时的HTTP状态码,支持5类状态码的组合,格式为http_1xx或http_2xx | 
| healthCheckHost | String | 7层健康检查请求的头部域会带指定的host字段,例如"localhost",默认""。当健康检查协议为"HTTP"时生效 | 
| serverTimeout | int | 后端服务器最大超时(单位:秒) | 
| redirectPort | int | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 | 
HTTPSListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection" | 
| keepSession | bool | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite" | 
| keepSessionDuration | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardFor | bool | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| additionalAttributes | AdditionalAttributesModel | HTTPS类型监听器定制配置 | 
| healthCheckType | String | 健康检查协议,值为"HTTP"/"TCP" | 
| healthCheckPort | int | 健康检查端口 | 
| healthCheckURI | String | 健康检查URI | 
| healthCheckTimeoutInSecond | int | 健康检查超时 | 
| healthCheckInterval | int | 健康检查间隔 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| healthCheckNormalStatus | String | 健康检查正常时的HTTP状态码,支持5类状态码的组合,格式为http_1xx 或 http_2xx | 
| healthCheckHost | String | 7层健康检查请求的头部域会带指定的host字段,例如"localhost",默认""。当健康检查协议为"HTTP"时生效 | 
| serverTimeout | int | 后端服务器最大超时(单位:秒) | 
| certIds | List<String> | 加载的SSl证书,目前HTTPS监听器只能绑定一个SSL证书 | 
| additionalCertDomains | List<AdditionalCertDomain> | 扩展域名 | 
| dualAuth | bool | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List<String> | 当dualAuth为true时,加载的客户端证书链 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List<String> | 加密协议 | 
| appliedCiphers | String | 加密套件 | 
SSLListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 | 
| healthCheckTimeoutInSecond | int | 健康检查超时 | 
| healthCheckInterval | int | 健康检查间隔 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| certIds | List<String> | 加载的SSl证书链 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List<String> | 加密协议 | 
| appliedCiphers | String | 加密套件 | 
| dualAuth | boolean | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List<String> | 当dualAuth为true时,加载的客户端证书链 | 
| serverTimeout | int | 后端服务器最大超时(单位:秒),默认900s,需为10-4000间的整数 | 
BackendServerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| instanceId | String | 后端服务器标识符 | 
| weight | int | 后端服务器权重,取值范围[0, 100],权重为0表示不要把流量转发到该后端服务器上 | 
BackendServerStatus
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| instanceId | String | 后端服务器标识符 | 
| weight | int | 后端服务器权重 | 
| status | String | 后端服务器健康状态,值为"Alive"/"Dead"/"Unknown" | 
AppBLBModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| blbId | String | LoadBalancer的标识符 | 
| name | String | LoadBalancer的名称 | 
| desc | String | LoadBalancer的描述 | 
| address | String | LoadBalancer的地址,点分十进制表示 | 
| status | blbStatus | BLB状态 | 
| subnetId | String | subnet 的ID | 
| vpcId | String | vpc短Id | 
| publicIp | String | 如果LoadBalancer绑定过EIP,则显示该项,否则不显示 | 
| tags | List | 
标签键值对列表 | 
| allowDelete | Boolean | 是否允许删除 | 
| eipRouteType | String | EIP线路类型 | 
| publicIpv6 | String | 如果LoadBalancer绑定过EIPv6,则显示该项,否则不显示 | 
| eipV6RouteType | String | EIPV6线路类型 | 
| paymentTiming | String | 计费方式 取值:"Postpaid" 后付费 "Prepaid" 预付费 | 
| billingMethod | String | 计费方式 取值:"ByCapacityUnit" 按使用量 "BySpec" 按固定规格 | 
TagModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| tagKey | String | 标签的键,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度1-65 | 
| tagValue | String | 标签的值,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度0-65 | 
ListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| port | String | 监听器端口 | 
| type | String | 监听器协议类型 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppTCPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接数、"Hash"代表根据源ip哈希 | 
| tcpSessionTimeout | int | tcp设置连接超时时间(单位:秒),默认为900,需为10-4000间的整数 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppUDPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"WeightLeastConn"代表加权最小连接数、"Hash"代表根据源ip哈希 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppHTTPListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 | 
| keepSession | boolean | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite" | 
| keepSessionTimeout | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardedFor | boolean | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| xForwardedProto | boolean | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议 | 
| serverTimeout | int | 后端服务器最大超时(单位:秒) | 
| redirectPort | int | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppHTTPSListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数 | 
| keepSession | boolean | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效,值为"insert"/"rewrite" | 
| keepSessionTimeout | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardedFor | boolean | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| xForwardedProto | boolean | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议 | 
| serverTimeout | int | 后端服务器最大超时(单位:秒) | 
| certIds | List<String> | 加载的SSl证书链 | 
| additionalCertDomains | List<AdditionalCertDomain> | 扩展域名 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List<String> | 加密协议 | 
| appliedCiphers | String | 加密套件 | 
| dualAuth | boolean | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List<String> | 当dualAuth为true时,加载的客户端证书链 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppSSLListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"Hash"代表根据源ip哈希 | 
| certIds | List<String> | 加载的SSl证书链 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List<String> | 加密协议 | 
| appliedCiphers | String | 加密套件 | 
| dualAuth | boolean | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List<String> | 当dualAuth为true时,加载的客户端证书链 | 
| description | String | 描述信息,长度不超过200个字符。 | 
AppBackendServer
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| instanceId | String | 后端服务器标识符 | 
| weight | int | 后端服务器权重,取值范围0-100 | 
| privateIp | String | 查询时返回值,后端绑定的该服务器ip地址 | 
| portList | List<AppRsPortModel> | 查询时返回值,设置了相应策略,RS开放的端口列表 | 
AppRsPortModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器端口(后端端口关联的监听器端口) | 
| backendPort | String | 后端开放的端口 | 
| portType | String | 端口协议类型(服务器组开放的端口类型,包含TCP、UDP、HTTP、HTTPS) | 
| healthCheckPortType | String | 健康检查端口协议类型(TCP、UDP、ICMP、HTTP、HTTPS) | 
| status | String | 端口状态,"Alive"/"Dead"/"Unknown" | 
| portId | String | 端口id | 
| policyId | String | 对应策略id | 
AppServerGroup
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| id | String | 后端服务器组标识符 | 
| name | String | 后端服务器组名称 | 
| desc | String | 后端服务器组描述 | 
| status | String | 服务器组状态,详见blbStatus | 
| portList | List<AppServerGroupPort> | 服务器组开放的端口列表 | 
AppServerGroupPort
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| id | String | 服务器组端口标识符 | 
| port | int | 服务器组开放端口号 | 
| type | String | 端口协议类型,"TCP"/"HTTP" | 
| status | String | 服务器组状态,详见blbStatus | 
| healthCheck | String | 健康检查协议,支持"HTTP"/"TCP" | 
| healthCheckPort | int | 健康检查端口 | 
| healthCheckTimeoutInSecond | int | 健康检查超时(单位:秒),默认为3,需为1-60间的整数 | 
| healthCheckIntervalInSecond | int | 健康检查间隔(单位:秒),默认为3,需为1-10间的整数 | 
| healthCheckDownRetry | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。默认为3,需为2-5间的整数 | 
| healthCheckUpRetry | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。默认为3,需为2-5间的整数 | 
| healthCheckNormalStatus | String | 健康检查正常时的HTTP状态码,支持5类状态码的组合,例如"http_1xx|http_2xx",默认"http_2xx|http_3xx"。当健康检查协议为"HTTP"时生效 | 
| healthCheckUrlPath | String | 健康检查URI,默认/。当健康检查协议为"HTTP"时生效 | 
| healthCheckHost | String | 7层健康检查请求的头部域会带指定的host字段,例如"localhost",默认""。当健康检查协议为"HTTP"时生效 | 
| udpHealthCheckString | String | udp健康检查字符串,当端口类型为udp是有效 | 
AppPolicy
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| id | String | 策略标识符 | 
| desc | String | 策略描述默认为空 | 
| appServerGroupId | String | 策略绑定服务器组标识符 | 
| appServerGroupName | String | 策略绑定服务器组名称 | 
| frontendPort | int | 前端服务器的监听端口 | 
| type | String | 前端服务器的监听端口协议 | 
| backendPort | int | 目标端口号,当listenerPort对应监听器为TCP或SSL时需要传入对应服务器组(appServerGroupId)下开放的TCP端口号;当listenerPort对应监听器为HTTP或HTTPS时需要传入对应服务器组(appServerGroupId)下开放的HTTP端口号;当listenerPort对应监听器为UDP时需要传入对应服务器组(appServerGroupId)下开放的UDP端口号 | 
| portType | String | 端口类型 | 
| priority | int | 策略优先级,有效取值范围是1-32768 | 
| ruleList | List<AppRule> | 策略规则列表 | 
| groupType | String | "Server" 表示后端绑定的是服务器组 | 
AppPolicyForUpdate
| 参数名称 | 类型 | 是否必须 | 描述 | 
|---|---|---|---|
| policyId | String | 是 | 转发策略id。 | 
| priority | Integer | 否 | 优先级,取值范围1-32768,且不能与已有条目重复。数值越小,优先级越高,规则匹配顺序为按优先级由高到低匹配。priority和description不能同时为空。 | 
| description | String | 否 | 描述信息。最大200字符。priority和description不能同时为空。 | 
AppRule
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| id | String | 规则的标识符 | 
| key | String | 规则的类型,host/uri/* | 
| value | String | 通配符匹配字符串,详见ValueExample | 
CreateAppPolicy
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| appServerGroupId | String | 是 | 策略绑定服务器组标识符 | 
| backendPort | int | 是 | 目标端口号,当listenerPort对应监听器为TCP或SSL时需要传入对应服务器组(appServerGroupId)下开放的TCP端口号;当listenerPort对应监听器为HTTP或HTTPS时需要传入对应服务器组(appServerGroupId)下开放的HTTP端口号;当listenerPort对应监听器为UDP时需要传入对应服务器组(appServerGroupId)下开放的UDP端口号 | 
| portType | String | 否 | 目标端口类型,当目标组是服务器组时默认为目标端口号所使用的协议 | 
| priority | int | 是 | 策略优先级,有效取值范围是1-32768 | 
| ruleList | List<CreateAppRule> | 是 | 策略规则列表 | 
| desc | String | 否 | 策略描述默认为空 | 
CreateAppRule
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| key | String | 是 | 规则的类型,host/uri/* | 
| value | String | 是 | 通配符匹配字符串,详见ValueExample | 
PortTypeModel
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| port | int | 是 | 监听端口 | 
| type | String | 是 | 监听端口的协议 | 
BillingForCreate
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| paymentTiming | String | 是 | 付款时间,预支付(Prepaid)和后支付(Postpaid),目前只支持预支付 | 
| billingMethod | String | 否 | 计费方式,后付费的时候传,"BySpec"按固定规格、"ByCapacityUnit"按使用量 | 
| reservation | ReservationForCreate | 是 | 保留信息,支付方式为后支付时不需要设置,预支付时必须设置 | 
ReservationForCreate
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| reservationLength | int | 是 | 购买月份时长,[1,2,3,4,5,6,7,8,9,12,24,36] | 
BillingForRenew
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| reservation | ReservationForCreate | 是 | 保留信息,预支付时必须设置 | 
Billing
| 参数名称 | 类型 | 是否必选 | 描述 | 
|---|---|---|---|
| paymentTiming | String | 是 | 付款时间,预支付(Prepaid)和后支付(Postpaid) | 
| billingMethod | String | 否 | 计费方式,预付费的时候不要传,后付费的时候传,按固定规格计费(BySpec)和按使用量计费(ByCapacityUnit) | 
| reservation | Reservation | 否 | 保留信息,支付方式为后支付时不需要设置,预支付时必须设置 | 
Reservation
| 参数名称 | 类型 | 是否必选 | 描述 | 
|---|---|---|---|
| reservationLength | Integer | 是 | 购买月份时长,取值范围为:[1,2,3,4,5,6,7,8,9,12,24,36] | 
Price
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| chargeItem | String | 计费项,比如取值"instance"代表实例费用;比如"netraffic"代表流量费用 | 
| discountPrice | String | 折扣价,单位都是元。预付费的时候,返回值比如:"150",后付费的时候,返回值比如:"0.00028" | 
| originalPrice | String | 原价 | 
| chargeUnit | String | 计费单位。后付费的时候取值,比如"minute"。minute:表示计价单元是按每分钟来计算。GB:表示计价单元是按每GB来计算。 "lcu"代表按每lcu单位计费 | 
AdditionalCertDomain
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| certId | String | 是 | 证书ID | 
| Host | String | 是 | 证书域名。若证书的产品类型为通配符域名版还支持通配符域名及其子域名 | 
AdditionalAttributesModel
| 参数名称 | 类型 | 是否必需 | 描述 | 
|---|---|---|---|
| gzipJson | String | 否 | 是否启用gzipJSON压缩,字符串类型,取值 "on" 或 "off" | 
ClusterModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| id | String | 集群id | 
| name | String | 集群名称 | 
| type | String | 集群类型 | 
| status | String | 集群状态 | 
| ccuCount | int | 集群性能容量 | 
| createTime | String | 集群创建时间 | 
| expireTime | String | 集群失效时间 | 
| desc | String | 描述 | 
AssociateBlbModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| blbId | String | 负载均衡id | 
| name | String | blb名称 | 
| status | String | blb状态 | 
| blbType | String | blb类型 | 
| publicIp | String | 公网ip | 
| eipRouteType | String | eip线路类型 | 
| bandwidth | int | 带宽 | 
| address | String | 内网ip地址 | 
| ipv6 | String | ipv6地址 | 
| vpcId | String | vpcId | 
| subnetId | String | 子网id | 
BlbSecurityGroupModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| securityGroupId | String | 普通安全组ID | 
| securityGroupName | String | 普通安全组名称 | 
| securityGroupDesc | String | 普通安全组描述 | 
| vpcName | String | 私有网络VPC名称 | 
| securityGroupRules | List<BlbSecurityGroupRuleModel> | 普通安全组规则 | 
BlbSecurityGroupRuleModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| securityGroupRuleId | String | 普通安全组规则ID | 
| direction | String | 入站/出站,取值ingress或egress | 
| ethertype | String | 网络类型,取值IPv4或IPv6,值为空时表示默认取值IPv4 | 
| portRange | String | 端口范围,可以指定80等单个端口,值为空时默认取值1-65535 | 
| protocol | String | 协议类型,tcp、udp或icmp,值为空时默认取值all | 
| sourceGroupId | String | 源安全组ID | 
| sourceIp | String | 源IP地址,与sourceGroupId不能同时设定值 | 
| destGroupId | String | 目的安全组ID | 
| destIp | String | 目的IP地址,与destGroupId不能同时设定值 | 
BlbEnterpriseSecurityGroupModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| enterpriseSecurityGroupId | String | 企业安全组ID | 
| enterpriseSecurityGroupName | String | 企业安全组名称 | 
| enterpriseSecurityGroupDesc | String | 企业安全组描述 | 
| enterpriseSecurityGroupRules | List<BlbEnterpriseSecurityGroupRuleModel> | 企业安全组规则 | 
BlbEnterpriseSecurityGroupRuleModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| remark | String | 备注,长度1-255。 | 
| direction | String | 入站/出站,取值ingress或egress。 | 
| ethertype | String | 网络类型,取值IPv4或IPv6。值为空时表示默认取值IPv4。 | 
| portRange | String | 端口范围,支持连续端口(比如“1-80”)和离散端口(比如“80,7000,8000”,英文逗号隔开,离散值数量不超过15个),值为空时默认取值1-65535。 | 
| protocol | String | 协议类型,tcp、udp或icmp,值为空时默认取值all。 | 
| sourceIp | String | 源IP地址,all表示全部。 | 
| destIp | String | 目的IP地址,all表示全部。 | 
| action | String | 允许/拒绝,取值allow或deny。 | 
| priority | Integer | 优先级,取值范围1-1000。 | 
| enterpriseSecurityGroupRuleId | String | 企业安全组规则ID | 
规则配置示例
ValueExample
| key | value | 描述 | 
|---|---|---|
| * | * | 全匹配 | 
| host | *.baidu.com | 匹配以“.baidu.com”结尾的域名 | 
| uri | /abc/def.* | 匹配以“/abc/def.”开头的URI路径 | 
状态编码定义
blbStatus
| 状态 | 描述 | 
|---|---|
| creating | 创建中 | 
| available | 运行中 | 
| updating | 更新中 | 
| paused | 已欠费 | 
| unavailable | 暂不可用 | 
加密类型、加密协议、加密套件
encryption
| encryptionType(加密类型) | encryptionProtocols(加密协议) | appliedCiphers(加密套件) | 
|---|---|---|
| tls_cipher_policy_default | ["tlsv10", "tlsv11", "tlsv12"] | ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES256-SHA:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES128-SHA256:DES-CBC3-SHA | 
| tls_cipher_policy_1_1 | ["tlsv11", "tlsv12"] | 同tls_cipher_policy_default | 
| tls_cipher_policy_1_2 | ["tlsv12"] | 同tls_cipher_policy_default | 
| tls_cipher_policy_1_2_secure | ["tlsv12"] | ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA | 
所有监听类型字段,具体返回值根据监听类型来返回
AllListenerModel
| 参数名称 | 类型 | 描述l | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| listenerType | String | 监听器的监听类型 | 
| backendPort | int | 后端服务器的监听端口 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"WeightLeastConn"代表加权最小连接数,"Hash"代表根据源ip哈希 | 
| healthCheckTimeoutInSecond | int | 健康检查超时时间 | 
| healthCheckInterval | int | 健康检查间隔时间 | 
| healthyThreshold | int | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用 | 
| unhealthyThreshold | int | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器 | 
| getBlbIp | bool | open-api作为隐形参数对特定有需求用户开放,目前只针对TCP类型可设置,其它类型默认为false,打开后4层数据流到达VM后,VM可通过tcp_option获取到原始blb的ip(vip/ovip)信息 | 
| tcpSessionTimeout | int | tcp设置连接超时时间(单位:秒) | 
| udpSessionTimeout | int | udp会话超时时间(单位:秒) | 
| healthCheckString | String | UDP健康检查发送的请求字符串 | 
| keepSession | bool | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效 | 
| keepSessionDuration | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardFor | bool | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| healthCheckType | String | 健康检查协议类型 | 
| healthCheckPort | int | 健康检查端口 | 
| healthCheckURI | String | 健康检查URI | 
| healthCheckNormalStatus | String | 健康检查正常时的HTTP状态码,支持5类状态码的组合,格式为http_1xx或http_2xx | 
| healthCheckHost | String | 7层健康检查请求的头部域会带指定的host字段,例如"localhost",默认""。当健康检查协议为"HTTP"时生效 | 
| serverTimeout | int | 后端服务器最大超时时间(单位:秒) | 
| redirectPort | int | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 | 
| certIds | List | 
加载的SSl证书,目前HTTPS监听器只能绑定一个SSL证书 | 
| dualAuth | bool | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List | 
当dualAuth为true时,加载的客户端证书链 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List | 
加密协议 | 
| appliedCiphers | String | 加密套件 | 
AppListenerModel
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| listenerPort | int | 监听器的监听端口 | 
| listenerType | String | 监听器的监听类型 | 
| scheduler | String | 负载均衡算法,值为"RoundRobin"/"LeastConnection"/"WeightLeastConn"/"Hash","RoundRobin"代表加权轮询、"LeastConnection"代表最小连接数、"WeightLeastConn"代表加权最小连接数,"Hash"代表根据源ip哈希 | 
| tcpSessionTimeout | int | tcp设置连接超时时间(单位:秒) | 
| udpSessionTimeout | int | udp设置连接超时时间(单位:秒) | 
| keepSession | bool | 是否开启会话保持功能,即同一个Client发出的请求都会到达同一个后端服务器 | 
| keepSessionType | String | 会话保持的cookie处理方式,当且仅当开启会话保持时有效 | 
| keepSessionTimeout | int | 会话保持的cookie有效时间(单位:秒),当且仅当开启会话保持时有效 | 
| keepSessionCookieName | String | 会话保持需要覆盖的cookie名称,当且仅当开启会话保持且keepSessionType="rewrite"时有效 | 
| xForwardFor | bool | 是否开启获取Client真实IP,开启后后端服务器上可以通过X-Forwarded-For这个HTTP Header来获得Client端的真实地址 | 
| xForwardedProto | bool | 是否开启获取监听协议,开启后后端服务器上可以通过X-Forwarded-Proto这个HTTP Header来获得监听协议 | 
| serverTimeout | int | 后端服务器最大超时时间(单位:秒) | 
| redirectPort | int | 将此监听器收到的请求转发到HTTPS监听器,HTTPS监听器通过这个端口指定 | 
| certIds | List | 
加载的SSl证书,目前HTTPS监听器只能绑定一个SSL证书 | 
| dualAuth | bool | 是否开启双向认证,默认为关闭 | 
| clientCertIds | List | 
当dualAuth为true时,加载的客户端证书链 | 
| encryptionType | String | 加密类型 | 
| encryptionProtocols | List | 
加密协议 | 
| appliedCiphers | String | 加密套件 | 
Auth
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| uid | String | 用户id,所有人使用"*" | 
| auth | String | 鉴权方式,取值:allow/deny,分别表示允许/拒绝 | 
Service
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| serviceId | String | 服务发布点的id | 
| name | String | 服务发布点的名称 | 
| description | String | 描述 | 
| serviceName | String | 服务名称 | 
| bindType | String | 绑定服务类型,目前仅支持绑定BLB实例 | 
| instanceId | String | 绑定实例ID | 
| status | String | 发布点状态,取值范围inService/available/unavailable/dead/free,分别表示:服务中/可用/不可用/故障/未绑定 | 
| service | String | 服务发布点唯一对应域名 | 
| createTime | String | 创建时间 | 
| endpointCount | int | 关联的服务网卡数量 | 
| endpointList | List<RelatedEndpoint> | 关联的服务网卡列表 | 
| authList | List<Auth> | 授权列表 | 
RelatedEndpoint
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| endpointId | String | 服务网卡的id | 
| uid | String | 服务网卡对应用户id | 
| attachTime | String | 关联时间 | 
