数据结构

最近更新时间:2026-07-07 10:58:11

我的收藏

AccessLogConfig

访问日志配置。

被如下接口引用:DescribeLoadBalancerDetail, DescribeLoadBalancers。

名称 类型 必选 描述
LogSetId String 负载均衡日志服务(CLS)的日志集ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:3e727335-f94c-468f-9989-21759a3b6de8
LogTopicId String 负载均衡日志服务(CLS)的日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:3e727335-f94c-468f-9989-21759a3b6de8

CertificateInfo

证书信息

被如下接口引用:DescribeListenerCertificates。

名称 类型 描述
AssociatedTime Timestamp ISO8601 证书绑定时间。
示例值:2024-06-12T10:34:56Z
CertificateId String 证书 ID。
示例值:Fm8Wp7x8
CertificateType String 证书类型。取值:CA或SVR(服务器证书)。
示例值:SVR
IsDefault Boolean 是否为监听器默认证书。取值:
true:默认证书。
false:扩展证书。
示例值:true
Status String 证书与监听器的绑定状态。取值:Associated(已关联)、Associating(关联中)、Disassociating(解除关联中)、Error(异常)。
示例值:Associated

DefaultAction

监听器默认规则动作

被如下接口引用:CreateListener, DescribeListenerDetail, ModifyListenerAttributes。

名称 类型 必选 描述
TargetGroupConfig TargetGroupConfig 转发目标组配置。创建监听器时转发动作中的目标组配置仅支持单个目标组。
Type String 转发动作类型。创建监听器时,默认转发动作类型仅支持转发至目标组。
示例值:TargetGroup

DeletionProtectionConfig

删除保护状态信息。

被如下接口引用:CreateLoadBalancer, DescribeLoadBalancerDetail, DescribeLoadBalancers, ModifyLoadBalancerAttributes。

名称 类型 必选 描述
DeletionProtectionEnabled Boolean 是否开启删除保护。开启后,可防止实例被意外删除。
- true:开启删除保护
- false:关闭删除保护
示例值:false
Reason String 开启修改保护的原因说明。
长度为 1~255 个字符,必须是中文和无害字符串中的字符, 可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)、下划线(_)。
示例值:防止误操作

Filter

过滤器条件

被如下接口引用:DescribeHealthCheckTemplates, DescribeListeners, DescribeLoadBalancers, DescribeRules, DescribeSecurityPolicies, DescribeTargetGroupTargets, DescribeTargetGroups。

名称 类型 必选 描述
Name String 过滤器的名称
示例值:tag-key
Values Array of String 过滤器的值数组
示例值:["1.0"]

FixedResponseInfo

固定应答信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
HttpCode Integer 返回的HTTP响应码,支持 2xx、4xx、5xx。
示例值:200
Content String 返回的固定内容。只支持 ASCII 字符,最大1KB。
示例值:OK
ContentType String 返回固定内容的格式。
取值:text/plain、text/css、text/html、application/javascript或application/json。
示例值:text/plain

HTTPCookieInfo

HTTP Cookie信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Key String Cookie的键,长度1~64个字符,支持字母、数字、下划线。
示例值:ClientVer
Value String Cookie的值,长度1~128个字符,支持可打印字符。
示例值:1.0

HTTPHeaderInfo

HTTP Header信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Key String HTTP Header的键,长度1 ~ 40个字符,支持的字符集为:a-z A-Z 0-9 - _ 。
不支持中文,不支持Host,Cookie。
示例值:ClientVer
Values Array of String HTTP Header的值,长度1 ~ 128个字符,支持可打印字符。
不支持",开头和结尾不能是空格,结尾不能是\。
示例值:["1.0"]

HTTPQueryStringInfo

HTTP查询字符串信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Key String 查询字符串的键,长度1 ~ 16个字符。支持可打印字符,不支持空格和#[]{}|<>&。
支持 * 多字符通配,? 单字符通配。


示例值:ClientVer
Value String 查询字符串的值,长度1 ~ 128字符,支持可打印字符,不支持空格和#[]{}|<>&。
支持 * 多字符通配,? 单字符通配。
示例值:1.0

HTTPRedirectInfo

HTTP重定向信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
HttpCode Integer 重定向的HTTP码,支持301、302、303、307、 308。
示例值:200
Host String 重定向的主机地址,默认值${host}。长度3 ~ 128个字符,支持的字符集为:a-z 0-9 _ . -。
示例值:example.com
Path String 重定向的路径,默认值${path}。长度1 ~ 128个字符,支持的字符集为:a-z 0-9 ? = _ . - / : 。
示例值:/hello/index.html
Port String 重定向的端口,默认值 ${port}。取值1 ~ 65535。
示例值:80
Protocol String 重定向的协议,取值:HTTP,HTTPS,默认值${protocol}。
示例值:HTTP
Query String 重定向的查询字符串,默认值${query}。长度1 ~ 128字符,支持可打印字符,不支持 #[]{}|<>& 和空格。
示例值:${query}

HTTPRewriteInfo

HTTP重写信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Host String 重写的主机地址,默认值${host}。长度3 ~ 128个字符,支持的字符集为:a-z 0-9 _ . -。
示例值:example.com
Path String 重写的路径,默认值${path}。长度1 ~ 128个字符,支持的字符集为:a-z 0-9 ? = _ . - / : 。
示例值:/hello/index.html
Query String 重写的查询字符串,默认值${query}。长度1 ~ 128字符,支持可打印字符,不支持 #[]{}|<>& 和空格。
示例值:${query}

HealthCheckConfig

健康检查配置

被如下接口引用:CreateTargetGroup, DescribeTargetGroups, ModifyTargetGroupAttributes。

名称 类型 必选 描述
HealthCheckEnabled Boolean 是否开启健康检查。
- true:开启。
- false:不开启。
示例值:true
HealthCheckCodes Array of String 健康检查状态码。取值:
- 当健康检查协议为HTTP/HTTPS时:
- http_1xx
- http_2xx(默认值)
- http_3xx
- http_4xx
- http_5xx
- 当健康检查协议为gRPC时:默认值为12,数值范围为0-99,输入值可为数值、多个数值或者范围以及相互组合,如:
- "20"
- "0-99"
> 仅当HealthCheckProtocol设置为HTTPHTTPSGRPC 或者GRPCS时,该参数生效。
示例值:["http_2xx"]
HealthCheckHealthyThreshold Integer 判定后端服务健康的阈值,当健康检查连续成功多少次后,后端服务的状态由不健康变为健康
取值范围:2-10
默认值:2
示例值:2
HealthCheckHost String 健康检查域名。该参数不设置时默认使用后端服务的内网IP作为健康检查地址。
域名限制:
- 长度限制为 1-255 个字符。
- 可包含小写字母、数字、短划线(-)和半角句号(.)。
- 至少包含一个半角句号(.),半角句号(.)不能出现在开头或结尾。
- 最右侧的域标签,只能包含字母,不能包含数字或短划线(-)。
- 短划线(-)不能出现在开头或结尾。
>仅当 HealthCheckProtocol 设置为 HTTP、HTTPSGRPCGRPCS 时,该参数生效。
示例值:example.com
HealthCheckHttpVersion String 健康检查 HTTP 协议版本,取值:
- HTTP1.1(默认)
- HTTP1.0
> 仅当HealthCheckProtocol设置为HTTPHTTPS 时,该参数生效。
示例值:HTTP1.1
HealthCheckInterval Integer 健康检查的时间间隔。单位:秒。
取值范围:2-300
默认值:5
示例值:10
HealthCheckMethod String 健康检查方法,取值:
- GET
- HEAD(默认值)
> 仅当HealthCheckProtocol设置为HTTPHTTPS 时,该参数生效。
示例值:GET
HealthCheckPath String 健康检查的转发规则路径。
长度为 1~80 个字符,只能使用字母、数字、字符-/.%?#&=以及扩展字符_;~!()*[]@$^:',+。 URL 必须以正斜线(/)开头。
> 仅当HealthCheckProtocolHTTPHTTPSGRPCGRPCS时,转发规则路径参数生效。
示例值:/hello/index.html
HealthCheckPort Integer 健康检查访问后端服务器的端口。

取值范围:0-65535

默认值:0,表示后端服务器的端口。
示例值:80
HealthCheckProtocol String 健康检查协议。取值:
- HTTP(默认):通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。
- HTTPS:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)
- TCP:通过发送 SYN 握手报文来检测服务器端口是否存活。
- GRPC:通过发送 POST 请求来检查服务器应用是否健康。
- GRPCS:通过发送 POST 请求来检查服务器应用是否健康。
示例值:HTTP
HealthCheckTimeout Integer 健康检查的响应超时时间。单位:秒。
取值范围:2-60
默认值:2
示例值:2
HealthCheckUnhealthyThreshold Integer 判定后端服务不健康的阈值,当健康检查连续失败多少次后,后端服务的状态由健康变为不健康
取值范围:2-10
默认值:2
示例值:2

HealthCheckTemplate

健康检查模板信息

被如下接口引用:DescribeHealthCheckTemplates。

名称 类型 描述
CreateTime Timestamp ISO8601 创建时间。
示例值:2025-01-01T08:30:00+08:00
HealthCheckCodes Array of String 健康检查状态码。取值:
- 当健康检查协议为HTTP/HTTPS时:
- http_1xx
- http_2xx(默认值)
- http_3xx
- http_4xx
- http_5xx
- 当健康检查协议为GRPC/GRPCS时:默认值为12,数值范围为0-99,输入值可为数值、多个数值或者范围以及相互组合,如:
- "20"
- "0-99"
示例值:["http_2xx"]
HealthCheckHealthyThreshold Integer 判定后端服务健康的阈值,当健康检查连续成功多少次后,后端服务的状态由不健康变为健康
取值范围:2-10
默认值:2
示例值:2
HealthCheckHost String 健康检查域名。
长度限制为 1-255 个字符。
可包含小写字母、数字、短划线(-)和半角句号(.)。

> 仅当 HealthCheckProtocol 设置为 HTTP/HTTPS/GRPC/GRPCS 时,该参数生效。
示例值:example.com
HealthCheckHttpVersion String 健康检查 HTTP 协议版本,取值:
- HTTP1.1(默认)
- HTTP1.0
> 仅当HealthCheckProtocol设置为HTTPHTTPS 时,该参数生效。
示例值:HTTP1.1
HealthCheckInterval Integer 健康检查的时间间隔。单位:秒。
取值范围:2-300
默认值:5
示例值:10
HealthCheckMethod String 健康检查方法,取值:
- GET
- HEAD(默认值)
> 仅当HealthCheckProtocol设置为HTTPHTTPS 时,该参数生效。
示例值:GET
HealthCheckPath String 健康检查的转发规则路径。 长度为 1-80 个字符,只能使用字母、数字、字符-/.%?#&=以及扩展字符_;~!()*[]@$^:',+。 URL 必须以正斜线(/)开头。
> 仅当HealthCheckProtocolHTTP/HTTPS/GRPC/GRPCS时,转发规则路径参数生效。
示例值:/hello/index.html
HealthCheckPort Integer 健康检查访问后端服务器的端口。

取值范围:0-65535

默认值:0,表示后端服务器的端口。
示例值:80
HealthCheckProtocol String 健康检查协议。取值:
- HTTP(默认):通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。
- HTTPS:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)
- TCP:通过发送 SYN 握手报文来检测服务器端口是否存活。
- GRPC:通过发送 POST 或 GET 请求来检查服务器应用是否健康。
- GRPCS:通过发送 POST 或 GET 请求来检查服务器应用是否健康。
示例值:HTTP
HealthCheckTemplateId String 健康检查模板 ID,格式为 hct- 后接字母数字。所有接口(创建、查询、修改、删除)均使用 hct- 前缀。
示例值:hct-m4x8q2pa
HealthCheckTemplateName String 健康检查模板名称。长度为 1-255 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。
示例值:target-group-health-check
HealthCheckTimeout Integer 健康检查的响应超时时间。单位:秒。
取值范围:2-60
默认值:2
示例值:2
HealthCheckUnhealthyThreshold Integer 判定后端服务不健康的阈值,当健康检查连续失败多少次后,后端服务的状态由健康变为不健康
取值范围:2-10
默认值:2
示例值:2
ModifyTime Timestamp ISO8601 修改时间。
示例值:2025-01-01T08:30:00+08:00
Tags Array of TagInfo 标签。

IPAddressInfo

应用型负载均衡可用区子网映射中的 IP 信息数据结构

被如下接口引用:CreateLoadBalancer, ModifyLoadBalancerAddressType。

名称 类型 必选 描述
Address String IP 地址
示例值:user.address
AddressId String EIP AddressId
示例值:eip-q7m2x4pa

InsertHTTPHeaderInfo

插入HTTP Header信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Key String 插入的HTTP Header键,长度1 ~ 40个字符,支持的字符集为:a-z A-Z 0-9 - _ 。
不支持中文,不支持Cookie,Host,Content-Length,Connection,Upgrade,transfer-encoding,keep-alive,te,authority,x-forwarded-for,x-forwarded-proto,x-forwarded-host,x-forwarded-port。
示例值:ClientVer
Value String HTTP Header值的类型。
ValueType为SystemDefined时,取值范围 ClientPort:客户端端口,ClientIp:客户端 IP 地址,Protocol:客户端请求的协议,CLBPort:负载均衡实例监听端口。
ValueType为UserDefined时,长度1 ~ 128的可打印字符,不支持",开头和结尾不能为空格,结尾不能为\。
ValueType为ReferenceHeader时,引用请求头中的某一个header,长度1~128的可打印字符,不支持",开头和结尾不能为空格,结尾不能为\。
示例值:1.0
ValueType String HTTP Header值的类型,取值:
SystemDefined:系统定义的header。
UserDefined:用户自定义的header。
ReferenceHeader:引用请求头中的某一个header。
示例值:UserDefined

Job

异步任务信息

被如下接口引用:DescribeAsyncJobs。

名称 类型 必选 描述
ApiName String 操作接口名称。
示例值:NotifyUnbindTarget
FlowId Integer 任务流Id
示例值:12345
RequestId String 任务请求Id。
示例值:req-f8q2xk9m9
ResourceIds Array of String 资源ID列表
示例值:[]
Status String 任务状态。取值:Processing、Succeeded、Failed。
示例值:Succeeded

ListenerOutput

监听器简要信息出参

被如下接口引用:DescribeListeners。

名称 类型 必选 描述
CaEnable Boolean 是否开启双向认证。
示例值:false
CreateTime Timestamp ISO8601 监听器实例的创建时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
示例值:2025-01-01T08:30:00+08:00
GzipEnabled Boolean 是否启用 Gzip 压缩。
示例值:false
Http2Enable Boolean 是否启用http2。
示例值:false
IdleTimeout Integer 空闲超时时间。
示例值:15
ListenerId String 监听器 ID,格式为 lst- 后接 8 位字母数字。
示例值:lst-d9p3k7wa
ListenerName String 监听器名称。
示例值:http-listener
ListenerPort Integer 监听器端口。
示例值:80
ListenerProtocol String 监听器协议。
示例值:HTTPS
ListenerStatus String 监听器状态。取值:=

- Active: 运行中。
- Provisioning:创建中。
- Configuring:变配中。
- ProvisionFailed:创建失败
示例值:Active
ModifyTime Timestamp ISO8601 监听器实例的最后变更时间。格式:ISO 8601(例如 2025-01-01T08:30:00+08:00)
示例值:2025-01-01T08:30:00+08:00
RequestTimeout Integer 请求超时时间。
示例值:60
Tags Array of TagInfo 标签。
TlsSecurityPolicyId String 安全策略 ID。
示例值:test-policy
XForwardedForConfig XForwardedForConfig XForwardedFor配置。

LoadBalancer

列表展示的应用型负载均衡实例结构。

被如下接口引用:DescribeLoadBalancers。

名称 类型 必选 描述
AccessLogConfig AccessLogConfig 访问日志配置结构。
AddressIpVersion String IP 地址版本,取值 IPv4 或 IPv6。
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv4
AddressType String 负载均衡的地址类型。取值:

- Internet:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。

- Intranet:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Internet
CreateTime String 资源创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2025-01-01T08:30:00+08:00
DeletionProtection DeletionProtectionConfig 删除保护设置信息。
Domain String DNS域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:alb-f8q2xk9m-vcpcq5puad9vp3xm.gz-tencentalb.com
LoadBalancerBillingConfig LoadBalancerBillingConfig 负载均衡实例计费配置。
LoadBalancerId String 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
注意:此字段可能返回 null,表示取不到有效值。
示例值:alb-f8q2xk9m
LoadBalancerName String 负载均衡实例名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:alb-f8q2xk9m-1
LoadBalancerOperationLocks Array of LoadBalancerOperationLocksItem 负载均衡操作锁配置。
注意:此字段可能返回 null,表示取不到有效值。
LoadBalancerStatus String 应用型负载均衡实例状态。取值:

- Provisioning:创建中。
- Active: 运行中。
- Configuring: 变配中。
- Deleting:删除中。
- ProvisionFailed:创建失败。
- ConfigureFailed:变配失败。
- DeletionFailed:删除失败。
- Abnormal:异常状态,具体异常原因参见LoadBalancerOperationLocks字段。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Active
ModificationProtection ModificationProtectionInfo 修改保护设置信息。
Tags Array of TagInfo 标签列表。
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 私有网络 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-92hffaxb

LoadBalancerAddress

应用型负载均衡可用区子网映射中的 IP 信息数据结构

被如下接口引用:CreateLoadBalancer, DescribeLoadBalancerDetail, ModifyLoadBalancerAddressType。

名称 类型 必选 描述
IPv4Address Array of IPAddressInfo IPv4 地址列表
IPv6Address Array of IPAddressInfo IPv6 地址列表

LoadBalancerBillingConfig

应用型负载均衡实例计费配置。

被如下接口引用:CreateLoadBalancer, DescribeLoadBalancerDetail, DescribeLoadBalancers。

名称 类型 必选 描述
ChargeType String 实例的计费类型。

取值POSTPAID_BY_HOUR:表示按量计费。
注意:此字段可能返回 null,表示取不到有效值。
示例值:POSTPAID_BY_HOUR
BandwidthPackageId String 共享带宽包 ID。
示例值:bwp-q8m2x4pa

LoadBalancerDetail

负载均衡详细信息

被如下接口引用:DescribeLoadBalancerDetail。

名称 类型 必选 描述
AccessLogConfig AccessLogConfig 访问日志配置。
AddressIpVersion String IP 地址版本,取值 IPv4 或 IPv6。
示例值:IPv4
AddressType String 应用型负载均衡实例的网络地址类型。取值:

- Internet/Public:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。

- Intranet/Internal:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。


示例值:Internet
CreateTime Timestamp ISO8601 资源创建时间,格式为yyyy-MM-ddTHH:mm:ss±hh:mm
示例值:2025-01-01T08:30:00+08:00
DeletionProtection DeletionProtectionConfig 删除保护设置信息。
Domain String DNS域名。
示例值:alb-f8q2xk9m-vcpcq5puad9vp3xm.gz-tencentalb.com
LoadBalancerBillingConfig LoadBalancerBillingConfig 负载均衡实例付计费配置信息
LoadBalancerId String 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
示例值:alb-f8q2xk9m
LoadBalancerName String 实例名称。

长度为1~80个字符,可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。
示例值:alb-f8q2xk9m-1
LoadBalancerOperationLocks Array of LoadBalancerOperationLocksItem 应用型负载均衡操作锁配置。
LoadBalancerStatus String 应用型负载均衡实例状态。取值:

- Provisioning:创建中。
- Active: 运行中。
- Configuring: 变配中。
- Deleting:删除中。
- ProvisionFailed:创建失败。
- ConfigureFailed:变配失败。
- DeletionFailed:删除失败。
- Abnormal:异常状态,具体异常原因参见LoadBalancerOperationLocks字段。
示例值:Active
ModificationProtection ModificationProtectionInfo 修改保护设置信息。
SecurityGroupIds Array of String 应用型负载均衡实例绑定的安全组ID集合。
示例值:[]
Tags Array of TagInfo 标签。
VpcId String 私有网络 ID。
示例值:vpc-92hffaxb
ZoneMappings Array of ZoneMappingInfo 可用区及子网映射列表,最多返回10个可用区。若当前地域支持2个及以上可用区,至少返回2个及以上可用区。

LoadBalancerOperationLocksItem

应用型负载均衡操作锁配置。

被如下接口引用:DescribeLoadBalancerDetail, DescribeLoadBalancers。

名称 类型 必选 描述
LockReason String 锁定的原因。在LoadBalancerStatusAbnormal时有效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:欠费隔离
LockType String 锁定的类型。取值 :

- SecurityLocked:安全锁定。

- RelatedResourceLocked:关联锁定。

- FinancialLocked:欠费锁定。

- ResidualLocked:残留锁定。
注意:此字段可能返回 null,表示取不到有效值。
示例值:SecurityLocked

ModificationProtectionInfo

修改保护状态信息。

被如下接口引用:DescribeLoadBalancerDetail, DescribeLoadBalancers。

名称 类型 必选 描述
ModificationProtectionEnabled Boolean 是否开启修改保护。开启后,可防止实例被意外修改或删除。
- true:开启修改保护
- false:关闭修改保护
示例值:false
OperatorUin String 1238716123
示例值:设置修改保护的子账号UIN
Reason String 开启修改保护的原因说明。
长度为 1~255 个字符,必须是中文和无害字符串中的字符, 可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)、下划线(_)。
示例值:生产环境实例,防止误操作

PostPayPriceInfo

描述了后付费计费项的价格信息

被如下接口引用:InquirePriceCreateLoadBalancer。

名称 类型 描述
Discount Float 折扣,如20.0代表2折。
注意:此字段可能返回 null,表示取不到有效值。
示例值:80.0
UnitPrice Float 单价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.5
UnitPriceDiscount Float 折扣单价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.2

Price

表示负载均衡的价格

被如下接口引用:InquirePriceCreateLoadBalancer。

名称 类型 描述
InstancePrice PostPayPriceInfo 描述了实例价格,单位:元/小时。
LcuPrice PostPayPriceInfo 描述了lcu价格,单位:元/个。

QuotaInfo

单个配额项的查询结果。每个结果对应一个配额类型;当请求中传入 ResourceIds 时,每个结果还会对应一个具体资源。

被如下接口引用:DescribeQuota。

名称 类型 必选 描述
Available Integer 当前剩余可用量,计算方式为 Limit - Used。仅当请求参数 DisplayFields 包含 available 时返回有效值;未请求时不返回或为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:40
Limit Integer 配额上限值。不同配额类型的单位不同,通常表示资源个数;超时时间类配额表示秒。
示例值:60
QuotaType String 配额类型,与请求参数 QuotaTypes 中的取值对应。每种配额类型的含义请参考 QuotaTypes 参数说明。
示例值:alb_quota_loadbalancers_num
ResourceId String 资源 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:alblcu-e8p3x9mq
Used Integer 当前已使用量。仅当请求参数 DisplayFields 包含 used 时返回有效值;未请求时不返回或为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20

RelatedListener

关联监听器信息

被如下接口引用:DescribeSecurityPolicyRelations。

名称 类型 必选 描述
ListenerId String 监听器 ID,格式为 lst- 后接 8 位字母数字。
示例值:lst-d9p3k7wa
ListenerPort Integer 监听器端口。
示例值:80
ListenerProtocol String 监听器协议。
示例值:HTTPS
LoadBalancerId String 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
示例值:alb-f8q2xk9m

RemoveHTTPHeaderInfo

删除HTTP Header信息

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Key String 要删除的HTTP Header的键,长度1 ~ 40个字符,支持的字符集为:a-z A-Z 0-9 - _ 。
不支持Cookie,Host,Content-Length,Connection,Upgrade,transfer-encoding,keep-alive,te,authority,x-forwarded-for,x-forwarded-proto,x-forwarded-host,x-forwarded-port,server
示例值:ClientVer

RuleAction

转发规则动作

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Order Integer 转发动作执行顺序,不能重复,按从小到大顺序执行。取值范围:1 ~ 50000。
示例值:1
Type String 转发动作类型。取值:
TargetGroup:转发至目标组。
Redirect:重定向。
FixedResponse:返回固定内容。
Rewrite:重写。
InsertHeader:写入HTTP Header。
RemoveHeader:删除HTTP Header。
转发动作必选包含TargetGroup,Redirect,FixedResponse其中一个,并且执行顺序放在最后。
示例值:TargetGroup
FixedResponseConfig FixedResponseInfo 固定响应内容配置。
InsertHeaderConfig InsertHTTPHeaderInfo 插入HTTP Header配置。
RedirectConfig HTTPRedirectInfo 重定向配置。除HttpCode外,其他配置不能都使用默认值。
RemoveHeaderConfig RemoveHTTPHeaderInfo 删除HTTP Header配置。
RewriteConfig HTTPRewriteInfo 重写配置。
TargetGroupConfig TargetGroupConfig 转发目标组配置。

RuleCondition

转发规则条件

被如下接口引用:CreateRules, DescribeRules, ModifyRulesAttributes。

名称 类型 必选 描述
Type String 转发条件类型。取值:
Host:主机。
Path:路径。
Header:HTTP Header字段。
QueryString:HTPP查询字符串。
Method:请求方法。
Cookie:Cookie。
SourceIp:源 IP。
示例值:Host
CookieConfig Array of HTTPCookieInfo Cookie配置。
HeaderConfig HTTPHeaderInfo HTTP Header配置。
HostConfig Array of String 主机名。主机配置在一个规则中只能出现一次,长度3 ~ 128个字符,支持精确匹配,正则匹配,通配匹配。
不能以半角句号(.)、下划线(_)开头或结尾。
精确匹配,支持的字符集为:a-z 0-9 . - _ 。
正则匹配,波浪线(~)开头为正则匹配,支持的字符集为:a-z 0-9 . - ? = ~ _ - + \ ^ * ! $ & | ( ) [ ] 。
通配匹配,星号(*)多字符通配,半角问号(?)单字符通配,支持的字符集为:a-z 0-9 . - _ * ?。
示例值:["www.myhost.com"]
MethodConfig Array of String 请求方法。取值:HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
示例值:["GET"]
PathConfig Array of String 转发路径。长度1 ~ 128个字符,支持精确匹配,正则匹配,通配匹配。
精确匹配,支持的字符集为:a-z A-Z 0-9 . - _ / = :。
正则匹配,需以 ~ 开头,~ 开头表示区分大小写, ~* 开头表示不区分大小写,支持的字符集为: a-z A-Z 0-9 . - _ / = ? ~ ^ * $ : ( ) [ ] + |。
通配匹配,* 表示多字符通配,? 表示单字符通配,支持的字符集为:a-z A-Z 0-9 . - _ / = :。
示例值:["/url"]
QueryStringConfig Array of HTTPQueryStringInfo 查询字符串配置。
SourceIpConfig Array of String 源IP匹配配置。CIDR格式,IP地址x.x.x.x/32,IP网段x.x.x.x/24。
示例值:["192.168.1.3/32"]

RuleHealthStatusInfo

规则健康检查状态

被如下接口引用:DescribeListenerHealthStatus。

名称 类型 描述
IsDefaultRule String 是否为默认转发规则。
示例值:true
RuleId String 转发规则 ID,格式为 rule- 后接 8 位字母数字。
示例值:rule-h8cy5gwl
TargetGroupHealthInfos Array of TargetGroupHealthInfo 目标组健康状态。

RuleInput

转发规则创建信息

被如下接口引用:CreateRules。

名称 类型 必选 描述
Actions Array of RuleAction 转发规则动作列表。
Conditions Array of RuleCondition 转发规则条件列表。
Priority Integer 优先级,值越小优先级越高,不能重复,取值范围:1~10000。
示例值:100
Direction String 转发规则的方向。Request:客户端到负载均衡的请求方向,Response:后端服务器到负载均衡的响应方向。默认Request。
示例值:Request
RuleName String 转发规则名称。长度为 1~255 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。
示例值:rule-h8cy5gwl
Tags Array of TagInfo 标签。

RuleModify

转发规则修改信息

被如下接口引用:ModifyRulesAttributes。

名称 类型 必选 描述
Actions Array of RuleAction 转发规则动作列表。
Conditions Array of RuleCondition 转发规则条件列表。
Priority Integer 优先级,值越小优先级越高,取值范围:1~10000。
示例值:100
RuleId String 转发规则 ID,格式为 rule- 后接 8 位字母数字。
示例值:rule-h8cy5gwl
RuleName String 转发规则名称。
示例值:rule-h8cy5gwl

RuleOutput

转发规则信息

被如下接口引用:DescribeRules。

名称 类型 描述
Actions Array of RuleAction 转发规则动作列表。
Conditions Array of RuleCondition 转发规则条件列表。
CreateTime Timestamp ISO8601 创建时间。
示例值:2025-01-01T08:30:00+08:00
Direction String 转发规则的方向。Request:客户端到负载均衡的请求方向,Response:后端服务器到负载均衡的响应方向。
示例值:Request
ModifyTime Timestamp ISO8601 最后修改时间。
示例值:2025-01-01T08:30:00+08:00
Priority Integer 优先级,值越小优先级越高,取值范围:1~10000。
示例值:100
RuleId String 转发规则 ID,格式为 rule- 后接 8 位字母数字。
示例值:rule-h8cy5gwl
RuleName String 转发规则名称。
示例值:rule-h8cy5gwl
Status String 转发规则状态,Provisioning:创建中,Active:运行中,Configuring:配置中。
示例值:Active
Tags Array of TagInfo 标签列表。

SecurityPolicyCapability

不同TLS版本支持的加密套件信息。

被如下接口引用:DescribeSecurityPolicyCapabilities。

名称 类型 必选 描述
Ciphers Array of String 支持的加密套件列表。
示例值:["TLS_AES_128_GCM_SHA256"]
TLSVersion String 支持的 TLS 协议版本。可选值包括:TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3。
示例值:TLSv1.3

SecurityPolicyInfo

安全策略信息。

被如下接口引用:DescribeSecurityPolicies, DescribeSystemSecurityPolicies。

名称 类型 描述
Ciphers Array of String 支持的加密套件列表。
支持的加密套件,具体依赖 TLSVersions 的取值。
Cipher 只要被任何一个传入的 TLSVersions 支持即可。

说明:若选择了 TLSv1.3,那么 Cipher 列表必须包含 TLSv1.3 支持的 Cipher。

请调用 DescribeSecurityPolicyCapabilities 接口获取支持的加密套件列表。
示例值:["TLS_AES_128_GCM_SHA256"]
CreateTime String 创建时间。
示例值:2025-01-01T08:30:00+08:00
SecurityPolicyId String 安全策略 ID,格式为 tls- 后接 8 位字母数字。
示例值:tls-t2ckydug
SecurityPolicyName String 安全策略名称。长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。
示例值:test-policy
Status String 安全策略状态。当前接口最常返回 Active,表示安全策略处于可用状态。
示例值:Active
TLSVersions Array of String 支持的 TLS 协议版本列表。可选值包括:TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3。
示例值:["TLSv1.2", "TLSv1.3"]
Tags Array of TagInfo 标签信息。

SecurityPolicyRelations

安全策略与监听的关联关系列表。

被如下接口引用:DescribeSecurityPolicyRelations。

名称 类型 必选 描述
RelatedListeners Array of RelatedListener 安全策略与监听的关联关系列表。
SecurityPolicyId String 安全策略 ID,格式为 tls- 后接 8 位字母数字。
示例值:tls-t2ckydug

StickySessionConfig

会话保持配置。

被如下接口引用:CreateTargetGroup, DescribeTargetGroups, ModifyTargetGroupAttributes。

名称 类型 必选 描述
StickySessionEnabled Boolean 是否开启会话保持。
- true:开启。
- false:不开启。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Cookie String 自定义 Cookie 名称。
长度为 1~255 个字符,只能包含英文字母和数字字符,且不能为tgw_l7_tg_route,该字段为目标组间会话保持Cookie保留字段。
>仅当 StickySessionEnabledtrue 时该参数生效。
示例值:SERVERID
CookieTimeout Integer 会话保持时间。
取值范围:1-86400,单位:
默认值:1000
>仅当 StickySessionEnabledtrue时,该参数生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
StickySessionType String 会话保持类型(处理Cookie的方式)。
- Insert(默认值):植入 Cookie。 客户端第一次访问后端服务时,应用型负载均衡会在返回请求中植入 Cookie。下次客户端请求时携带该 Cookie,负载均衡将请求转发到上次请求的相同后端服务。
- Rewrite:重写 Cookie。 负载均衡会对用户自定义的 Cookie 进行重写,下次客户端请求时携带该 Cookie,负载均衡将请求转发到上次请求的相同后端服务。
>仅当 StickySessionEnabledtrue 时该参数生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Insert

TagInfo

标签信息

被如下接口引用:CreateHealthCheckTemplate, CreateListener, CreateLoadBalancer, CreateRules, CreateSecurityPolicy, CreateTargetGroup, DescribeHealthCheckTemplates, DescribeListenerDetail, DescribeListeners, DescribeLoadBalancerDetail, DescribeLoadBalancers, DescribeRules, DescribeSecurityPolicies, DescribeSystemSecurityPolicies, DescribeTargetGroups, ModifyHealthCheckTemplate。

名称 类型 必选 描述
TagKey String 标签的键
示例值:env
TagValue String 标签的值
示例值:prod

TargetGroupConfig

目标组配置

被如下接口引用:CreateListener, CreateRules, DescribeListenerDetail, DescribeRules, ModifyListenerAttributes, ModifyRulesAttributes。

名称 类型 必选 描述
TargetGroups Array of TargetGroupTuple 目标组列表。
TargetGroupStickySession TargetGroupStickySession 目标组间会话保持

TargetGroupHealthInfo

目标组健康检查状态

被如下接口引用:DescribeListenerHealthStatus。

名称 类型 描述
HealthCheckEnabled Boolean 是否开启健康检查。
示例值:true
TargetGroupId String 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
示例值:lbtg-0zrnc9qa
TargetHealthStatusInfos Array of TargetHealthStatusInfo 服务健康检查状态列表。
Type String 转发动作类型。取值:
TargetGroup:转发至目标组。
Redirect:重定向。
FixedResponse:返回固定内容。
Rewrite:重写。
InsertHeader:写入HTTP Header。
RemoveHeader:删除HTTP Header。
转发动作必选包含TargetGroup,Redirect,FixedResponse其中一个,并且执行顺序放在最后。
示例值:TargetGroup

TargetGroupOutput

目标组简要信息出参

被如下接口引用:DescribeTargetGroups。

名称 类型 描述
CreateTime Timestamp ISO8601 创建时间。
示例值:2025-01-01T08:30:00+08:00
HealthCheckConfig HealthCheckConfig 健康检查配置。
KeepaliveEnabled Boolean 是否开启长连接。
示例值:true
Protocol String 后端服务协议类型。取值:
- HTTP(默认):支持绑定HTTP、HTTPS的监听器
- HTTPS:支持绑定HTTPS类型的监听器
- GRPC:支持绑定HTTPS类型的监听器
- GRPCS:支持绑定HTTPS类型的监听器
示例值:HTTP
RelatedLoadBalancersCount Integer 目标组关联的负载均衡数量。
示例值:0
SchedulerAlgorithm String 调度算法。
示例值:wrr
StickySessionConfig StickySessionConfig 会话保持配置。
Tags Array of TagInfo 标签。
TargetGroupId String 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
示例值:lbtg-0zrnc9qa
TargetGroupName String 目标组名称。默认为目标组ID。长度为 1-255 个字符,可包含数字、大小写字母、中文、半角句号(.)、下划线(_)和短划线(-)。
示例值:target-group-name
TargetGroupStatus String 目标组状态。取值:
- Provisioning:创建中。
- ProvisionFailed:创建失败。
- Active: 运行中。
- Configuring:配置变更中。
示例值:Active
TargetType String 目标组类型。取值:
- Instance:Cvm服务器类型或Eni弹性网卡类型
示例值:CVM
VpcId String 私有网络 ID。
示例值:vpc-92hffaxb

TargetGroupStickySession

目标组之间会话保持

被如下接口引用:CreateListener, DescribeListenerDetail, ModifyListenerAttributes。

名称 类型 必选 描述
Enabled Boolean 是否开启会话保持,默认关闭。
示例值:false
Timeout Integer 超时时间,单位秒,取值范围:1~86400,默认值:1000。
示例值:1000

TargetGroupTuple

目标组基础配置

被如下接口引用:CreateListener, DescribeListenerDetail, ModifyListenerAttributes。

名称 类型 必选 描述
TargetGroupId String 目标组 ID,格式为 lbtg- 后接 8 位字母数字。
示例值:lbtg-0zrnc9qa
Weight Integer 权重,取值范围:[0, 100],默认为 10。
示例值:10

TargetHealthStatusInfo

服务健康状态信息

被如下接口引用:DescribeListenerHealthStatus。

名称 类型 描述
Status String 后端服务健康状态。DescribeListenerHealthStatus 仅返回非健康后端时,该值为 UnHealthy。
示例值:UnHealthy
TargetId String 后端服务实例 ID,CVM 实例格式为 ins- 后接 8 位字母数字。
示例值:ins-x8q2m4pa
TargetIp String 后端目标服务IP。
示例值:10.0.0.1
TargetPort Integer 后端服务器端口。
示例值:80

TargetOutput

后端服务输出参数。

被如下接口引用:DescribeTargetGroupTargets。

名称 类型 描述
EniId String 弹性网卡 ID。
示例值:eni-p4q7x2ma
Port Integer 后端服务器使用的端口。取值范围:1 - 65535
示例值:80
TargetId String 后端服务实例 ID,CVM 实例格式为 ins- 后接 8 位字母数字。
示例值:ins-x8q2m4pa
TargetIp String 后端服务IP。TargetIpTargetId需要至少传一个。

- 当服务器组为 Instance 类型时,该参数为 Eni 的主内网 IP 或辅助内网 IP。

示例值:10.0.0.1
TargetName String 后端服务名称。当前只有CVM后端类型后端服务返回有效名称。
示例值:test-xxxx
TargetStatus String 后端服务的状态。取值:
- Adding:添加中。
- Active:正常可用状态。
- Configuring:配置中。
- Removing:移除中。
示例值:Active
TargetType String 后端服务类型。
示例值:CVM
Weight Integer 后端服务的权重,取值范围:0 - 100。默认值为100。如果设置权重为0,则不会将请求转发给该后端服务。
示例值:10

TargetToAdd

添加至目标组的后端服务

被如下接口引用:AddTargetsToTargetGroup。

名称 类型 必选 描述
Port Integer 后端服务器使用的端口。取值范围:1 - 65535

>当目标组的 targetType 取值为 Instance 时,该参数必传。
示例值:80
TargetIp String 后端服务IP。TargetIpTargetId需要至少传一个。

- 当服务器组为 Instance 类型时,该参数为 Eni 的主内网 IP 或辅助内网 IP。

示例值:10.0.0.1
Weight Integer 后端服务的权重,取值范围:0 - 100。默认值为10。如果设置权重为0,则不会将请求转发给该后端服务。
示例值:10

TargetToModify

需要修改的后端服务。

被如下接口引用:ModifyTargetsInTargetGroup。

名称 类型 必选 描述
TargetIp String 后端服务IP。TargetIpTargetId需要至少传一个。

- 当服务器组为 Instance 类型时,该参数为 Eni 的主内网 IP 或辅助内网 IP。

示例值:10.0.0.1
Port Integer 后端服务器使用的端口。取值范围:1 - 65535

>当目标组的 targetType 取值为 Instance 时,该参数必传。
示例值:80
Weight Integer 后端服务的权重,取值范围:0 - 100。如果设置权重为0,则不会将请求转发给该后端服务。
示例值:10

TargetToRemove

从目标组移除的后端服务。

被如下接口引用:RemoveTargetsFromTargetGroup。

名称 类型 必选 描述
Port Integer 后端服务器使用的端口。取值范围:1 - 65535

>当目标组的 targetType 取值为 Instance 时,该参数必传。
示例值:80
TargetIp String 后端服务IP。TargetIpTargetId需要至少传一个。

- 当服务器组为 Instance 类型时,该参数为 Eni 的主内网 IP 或辅助内网 IP。

示例值:10.0.0.1

XForwardedForConfig

转发配置

被如下接口引用:CreateListener, DescribeListenerDetail, DescribeListeners, ModifyListenerAttributes。

名称 类型 必选 描述
XForwardedForAlbIdEnabled Boolean 是否通过 ALB-ID 头字段获取负载均衡实例ID。
- true:是。
- false:否。
示例值:false
XForwardedForClientSrcPortEnabled Boolean 是否通过X-Forwarded-Client-srcport头字段获取访问负载均衡实例客户端的端口。
- true:是。
- false:否。
示例值:false
XForwardedForHostEnabled Boolean 是否开启通过X-Forwarded-Host头字段获取访问负载均衡实例客户端的域名。
- true:是。
- false:否。
示例值:false
XForwardedForMode String 指定如何处理 X-Forwarded-For(XFF)HTTP 头字段。
- append: 附加模式(默认),将客户端的真实 IP 地址附加到 X-Forwarded-For 头的末尾,保留原有的 XFF 链路信息
- remove: 删除模式,移除 X-Forwarded-For 头字段,不将该头传递给后端服务器
- passthrough: 透传模式,保持 X-Forwarded-For 头不变,直接透传给后端服务器,不做任何修改

示例值:append
XForwardedForPortEnabled Boolean 是否通过X-Forwarded-Port头字段获取负载均衡实例的监听端口。
- true:是。
- false:否。
示例值:false
XForwardedForProtoEnabled Boolean 是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。
- true:是。
- false:否。

示例值:false
XTencentClientIDNEnabled Boolean 是否通过 X-Tencent-Client-IDN 头访问 客户端证书的颁发者 $ssl_client_i_dn。
- true:是。
- false:否。

示例值:false
XTencentClientSDNEnabled Boolean 是否通过 X-Tencent-Client-SDN 头访问客户端证书的主题$ssl_client_s_dn。
- true:是。
- false:否。

示例值:false
XTencentClientSerialEnabled Boolean 是否通过 X-Tencent-Client-Serial 头访问 客户端证书的序列号 $ssl_client_serial。
- true:是。
- false:否。

示例值:false
XTencentClientVerifyEnabled Boolean 是通过 X-Tencent-Client-Verify 头访问 客户端证书的验证结果 $ssl_client_verify。
- true:是。
- false:否。

示例值:false

Zone

可用区信息

被如下接口引用:DescribeZones。

名称 类型 描述
LocalName String 可用区名称
示例值:广州三区
ZoneId String 可用区 ID
示例值:ap-guangzhou-3
ZoneStatus String 可用区状态
示例值:available

ZoneMappingInfo

可用区及子网映射结构体

被如下接口引用:DescribeLoadBalancerDetail。

名称 类型 必选 描述
SubnetId String 子网 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-bi75pogm
ZoneId String 可用区ID。最多支持添加10个可用区。若当前地域支持2个及以上的可用区,至少需要添加2个可用区。
您可以通过调用DescribeZones接口获取可用区ID对应的可用区的信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-3
LoadBalancerAddress LoadBalancerAddress 负载均衡 VIP/EIP 信息
Status String 可用区状态。取值:
- Active:运行中。
- Stopped:已停止。
- Shifted:已移除。
- Starting:启动中。
- Stopping:停止中。
示例值:Active

ZoneMappingsItem

用于购买或者修改使用的可用区及子网映射结构体

被如下接口引用:CreateLoadBalancer, ModifyLoadBalancerAddressType。

名称 类型 必选 描述
SubnetId String

子网 ID。


注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-bi75pogm
ZoneId String

可用区ID。最多支持添加10个可用区。若当前地域支持2个及以上的可用区,至少需要添加2个可用区。
您可以通过调用DescribeZones接口获取可用区ID对应的可用区的信息。


注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-3
LoadBalancerAddress LoadBalancerAddress

公网实例绑定的EIP实例ID。


注意:此字段可能返回 null,表示取不到有效值。