tencent cloud

APIs

문서APIsApplication Load BalancerData Types

Data Types

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-09-28 15:10:59

AccessLogConfig

Access log configuration.

Used by actions: DescribeLoadBalancerDetail, DescribeLoadBalancers.

Name Type Required Description
LogSetId String No Log set ID of Cloud Log Service (CLS) for CLB
LogTopicId String No Log topic ID of Cloud Log Service (CLS) for CLB

CertificateInfo

Certificate information.

Used by actions: DescribeListenerCertificates.

Name Type Description
AssociatedTime Timestamp ISO8601 Certificate binding time.
CertificateId String Certificate ID.
CertificateType String Certificate type. Valid values: CA or SVR (server certificate).
IsDefault Boolean Whether it is the default certificate of the listener. Value:
true: default certificate.
false: expand the certificate.
Status String The binding status of the certificate and listener. Values: Associated, Associating, Disassociating, Error.

DefaultAction

Default rule action of the listener

Used by actions: CreateListener, DescribeListenerDetail, ModifyListenerAttributes.

Name Type Required Description
TargetGroupConfig TargetGroupConfig Yes Forwarding target group configuration. When a listener is created, the target group configuration in the forwarding action enables only a single target group.
Type String Yes Forward action type. When a listener is created, the default forward action type only supports forwarding to a target group.

DeletionProtectionConfig

Deletion protection status information.

Used by actions: CreateLoadBalancer, DescribeLoadBalancerDetail, DescribeLoadBalancers, ModifyLoadBalancerAttributes.

Name Type Required Description
DeletionProtectionEnabled Boolean No Whether to enable deletion protection. Once enabled, instances can be prevented from being deleted accidentally.
- true: enable deletion protection
- false: disable deletion protection
Reason String No Reason explanation for enabling modification protection.
Length: 1 to 255 characters. It must contain Chinese and characters from harmless strings. It can contain Chinese, letters, digits, hyphens (-), forward slashes (/), half-width periods (.), and underscores (_).

Filter

Filter criteria

Used by actions: DescribeHealthCheckTemplates, DescribeListeners, DescribeLoadBalancers, DescribeRules, DescribeSecurityPolicies, DescribeTargetGroupTargets, DescribeTargetGroups.

Name Type Required Description
Name String Yes Filter name
Values Array of String Yes Filter value array

FixedResponseInfo

information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
HttpCode Integer Yes HTTP response code returned. 2xx, 4xx, and 5xx are supported.
Content String No Fixed content returned. Supports only ASCII characters, up to 1 KB.
ContentType String No Format of the returned fixed content.
Value: text/plain, text/css, text/html, application/javascript, or application/json.

HTTPCookieInfo

HTTP Cookie information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Key String Yes Key of the Cookie, 1-64 characters, supporting letters, digits, and underscores.
Value String Yes Cookie value, 1–128 characters in length, supporting printable characters.

HTTPHeaderInfo

HTTP Header information.

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Key String Yes Key of the HTTP Header. Length: 1–40 characters. Supported character sets: a-z a-z 0-9 - _
Chinese characters are not allowed. No support for Host and Cookie.
Values Array of String Yes Value of the HTTP Header. Length: 1-128 characters. Printable characters supported.
Unsupported. It cannot begin or end with a space, and cannot end with a backslash.

HTTPQueryStringInfo

HTTP query string information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Key String Yes Key of the query string. Length: 1–16 characters. Supports printable characters. Does not support spaces or #[]{}|<>&.
Supports * as a multi-character wildcard and ? as a single-character wildcard.
Value String Yes Value of the query string. Length: 1–128 characters. Supports printable characters. Does not support spaces or #[]{}|<>&.
Supports * as a multi-character wildcard and ? as a single-character wildcard.

HTTPRedirectInfo

HTTP redirection information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
HttpCode Integer Yes

HTTP code for redirection. Supports 301, 302, 303, 307, and 308.
Host String No

Redirected host address. Default value: ${host}. Length: 3-128 characters. Supported character sets: a-z 0-9 _ . -.
Path String No

Redirect path. Default value: ${path}. Length: 1–128 characters. Supported character sets: a-z A-Z 0-9 ? = _ . - / : .
Port String No

The port for redirection. Default value: ${port}. Value range: 1-65535.
Protocol String No

Protocol for redirection. Valid values: HTTP and HTTPS. Default value: ${protocol}.
Query String No

Query string for redirect. Default value: ${query}. Length: 1–128 characters. Supports printable characters. Does not support #[]{}<>& and spaces.

HTTPRewriteInfo

HTTP rewrite information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Host String No

Rewritten host address. Default value: ${host}. Length: 3-128 characters. Supported character sets: a-z 0-9 _ . -.
Path String No

Rewrite path. Default value: ${path}. Length: 1–128 characters. Supported character sets: a-z A-Z 0-9 ? = _ . - / : .
Query String No

Rewritten query string. Default value: ${query}. Length: 1–128 characters. Supports printable characters. Does not support #[]{}|<>& or spaces.

HealthCheckConfig

Health check configuration

Used by actions: CreateTargetGroup, DescribeTargetGroups, ModifyTargetGroupAttributes.

Name Type Required Description
HealthCheckEnabled Boolean Yes Whether to enable the health check.
- true: enable.
- false: not enabled.
HealthCheckCodes Array of String No Health check status code. Value:
- When the health check protocol is HTTP/HTTPS:
- http_1xx
- http_2xx (default value)
- http_3xx
- http_4xx
- http_5xx
- When the health check protocol is gRPC: default value: 12, value range: 0-99. The input value can be a numerical value, multiple values, a range, or a composite of these, for example:
- "20"
- "0-99"
> This parameter takes effect only when HealthCheckProtocol is set to HTTP, HTTPS, GRPC, or GRPCS.
HealthCheckHealthyThreshold Integer No Threshold for determining backend service health. After the number of consecutive successful health checks reaches this value, the backend service status changes from unhealthy to healthy.
Value range: 2-10.
Default value: 2.
HealthCheckHost String No Health check domain. If this parameter is not set, the intranet IP of the backend service is used as the health check address by default.
Domain restriction:
-Length limit: 1-255 characters.
- It can contain lowercase letters, digits, hyphens (-), and half-width periods (.).
-At least one half-width period (.) is required, and it cannot appear at the beginning or end.
-The rightmost domain tag can only contain letters. It cannot contain digits or en dashes (-).
-En dash (-) cannot appear at the beginning or end.
>This parameter takes effect only when HealthCheckProtocol is set to HTTP, HTTPS, GRPC, or GRPCS.
HealthCheckHttpVersion String No HTTP version for health check.
- HTTP1.1 (default)
- HTTP1.0
> This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckInterval Integer No Health check interval. Unit: second.
Valid values: 2-300.
Default value: 5.
HealthCheckMethod String No Health check method. Valid values:
- GET
- HEAD (default value)
> This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckPath String No Forwarding rule path for health check.
Length: 1–80 characters. Only letters, digits, characters -/.%?#&= and extended characters _;~!()*[]@$^:',+ can be used. The URL must start with a forward slash (/).
> The forwarding rule path parameter takes effect only when HealthCheckProtocol is set to HTTP, HTTPS, GRPC, or GRPCS.
HealthCheckPort Integer No Health check accesses the backend server port.

Valid values: 0-65535.

Default value: 0, which indicates the backend server port.
HealthCheckProtocol String No Health check protocol. Valid values:
- HTTP (default): Simulate browser access requests by sending HEAD or GET requests to check whether the server application is healthy.
- HTTPS: Checks the health of a server application by sending HEAD or GET requests to simulate browser access requests. (Encrypts data and is more secure compared with HTTP.)
- TCP: Detect whether the server port is alive by sending SYN handshake messages.
- GRPC: Check whether the server application is healthy by sending a POST request.
- GRPCS: Send a POST request to check whether the server application is healthy.
HealthCheckTimeout Integer No timeout period for health check. Unit: seconds.
Valid values: 2-60.
Default value: 2.
HealthCheckUnhealthyThreshold Integer No Threshold for determining an unhealthy backend service. The backend service status changes from healthy to unhealthy after the health check fails this number of consecutive times.
Value range: 2-10.
Default value: 2.

HealthCheckTemplate

Health check template information

Used by actions: DescribeHealthCheckTemplates.

Name Type Description
CreateTime Timestamp ISO8601 Creation time.
HealthCheckCodes Array of String Health check status code. Value:
- When the health check protocol is HTTP/HTTPS:
- http_1xx
- http_2xx (default value)
- http_3xx
- http_4xx
- http_5xx
- When the health check protocol is GRPC/GRPCS: default value is 12, value range is 0-99, input value can be numerical, multiple values or ranges, as well as combinations, for example:
- "20"
- "0-99"
HealthCheckHealthyThreshold Integer Threshold for determining backend service health. The backend service status changes from unhealthy to healthy after this number of consecutive successful health checks.
Value range: 2-10.
Default value: 2.
HealthCheckHost String Health check domain name.
Length limit: 1-255 characters.
It can contain lowercase letters, digits, hyphens (-), and half-width periods (.).

> This parameter takes effect only when HealthCheckProtocol is set to HTTP/HTTPS/GRPC/GRPCS.
HealthCheckHttpVersion String HTTP version for health check. Parameter Value:
- HTTP1.1 (default)
- HTTP1.0
> This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckInterval Integer The interval of health check. Unit: second.
Valid values: 2-300.
Default value: 5.
HealthCheckMethod String Health check method. Valid values:
- GET
- HEAD (default value)
> This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckPath String Health check forwarding rule path. Length: 1-80 characters. Only letters, digits, characters -/.%?#&= and extended characters _;~!（)*[]@$^:',+ can be used. The URL must start with a forward slash (/).
> The forwarding rule path parameter takes effect only when HealthCheckProtocol is set to HTTP/HTTPS/GRPC/GRPCS.
HealthCheckPort Integer Port for health check to access the backend server.

Valid values: 0-65535.

Default value: 0, which indicates the backend server port.
HealthCheckProtocol String Health check protocol. Valid values:
- HTTP (default): Check whether the server application is healthy by sending HEAD or GET requests to simulate browser access requests.
- HTTPS: Check whether the server application is healthy by sending HEAD or GET requests to simulate browser access requests. (Encrypt data, more secure compared with HTTP.)
- TCP: Detect whether the server port is alive by sending SYN handshake messages.
- GRPC: Check whether the server application is healthy by sending a POST or GET request.
- GRPCS: Check whether the server application is healthy by sending a POST or GET request.
HealthCheckTemplateId String Health check template ID, in the format of hct- followed by alphanumeric characters. All APIs (creation, querying, modification, deletion) use the hct- prefix.
HealthCheckTemplateName String Health check template name. It must contain 1-255 characters, consisting of digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-).
HealthCheckTimeout Integer timeout period for the health check. Unit: seconds.
Valid values: 2-60.
Default value: 2.
HealthCheckUnhealthyThreshold Integer Threshold for determining an unhealthy backend service. The backend service status changes from healthy to unhealthy after the health check fails this number of times consecutively.
Value range: 2-10.
Default value: 2.
ModifyTime Timestamp ISO8601 Modify the time.
Tags Array of TagInfo Tag.

IPAddressInfo

IP information data structure in the application CLB availability zone subnet mapping

Used by actions: CreateLoadBalancer, ModifyLoadBalancerAddressType.

Name Type Required Description
Address String No IP
AddressId String No EIP AddressId

InsertHTTPHeaderInfo

Insert HTTP Header information.

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Key String Yes Key of the inserted HTTP Header. Length: 1–40 characters. Supported character sets: a-z, a-z, 0-9, -, and _.
Chinese characters are not allowed. No support for Cookie, Host, Content-Length, Connection, Upgrade, transfer-encoding, keep-alive, te, authority, x-forwarded-for, x-forwarded-proto, x-forwarded-host, and x-forwarded-port.
Value String Yes Type of the HTTP Header value.
When ValueType is SystemDefined, the value range is as follows: ClientPort: client port, ClientIp: client IP address, Protocol: protocol of client requests, CLBPort: listening port of the load balancing instance.
When ValueType is UserDefined, it is a printable character of 1 to 128 characters in length. It does not support ". It cannot be space at the beginning and ending, and cannot be \ at the end.
When ValueType is ReferenceHeader, refer to a header in the request header. It must be 1–128 printable characters. It does not support ". It cannot begin or end with a space, and cannot end with .
ValueType String Yes Type of the HTTP Header value. Value:
SystemDefined: system defined header.
UserDefined: user-defined header.
ReferenceHeader: refers to one header in the request header.

Job

Asynchronous Task Information

Used by actions: DescribeAsyncJobs.

Name Type Required Description
ApiName String No Operation interface name.
FlowId Integer No Task flow Id
RequestId String No Task request Id.
ResourceIds Array of String No Resource ID list.
Status String No Task status. Valid values: Processing, Succeeded, Failed.

ListenerOutput

Listener brief information output parameters

Used by actions: DescribeListeners.

Name Type Required Description
CaEnable Boolean No

Whether mutual authentication is enabled.
CreateTime Timestamp ISO8601 No

Creation time of the listener instance. Format: ISO 8601 (for example, 2025-01-01T08:30:00+08:00)
GzipEnabled Boolean No

Whether to enable Gzip compression.
Http2Enable Boolean No

Whether to enable http/2.
IdleTimeout Integer No

Idle timeout period.
ListenerId String No

Listener ID, format: lst- followed by 8 alphanumeric characters.
ListenerName String No

Listener name.
ListenerPort Integer No

Listener port.
ListenerProtocol String No

Listener protocol.
ListenerStatus String No

Listener status. Value:

  • Active: Running.
  • Provisioning: Creating.
  • Configuring: Modifying configuration.
  • ProvisionFailed: Creation failed
ModifyTime Timestamp ISO8601 No

Last change time of the listener instance. Format: ISO 8601 (for example, 2025-01-01T08:30:00+08:00)
RequestTimeout Integer No

Connection request timeout period.
Tags Array of TagInfo No

Tag.
TlsSecurityPolicyId String No

Security policy ID.
XForwardedForConfig XForwardedForConfig No

XForwardedFor configuration.

LoadBalancer

Structure of application CLB instances in list view.

Used by actions: DescribeLoadBalancers.

Name Type Required Description
AccessLogConfig AccessLogConfig No Access log configuration architecture.
AddressIpVersion String No IP address version. Value: IPv4 or IPv6.
AddressType String No LoadBalancer address type. Valid values:

- Internet: The load balancing has a public IP address, and the DNS domain name is resolved to the public IP, so it can be accessed via the public network.

- Intranet: The load balancer only has a private IP address, and the DNS domain name resolves to the private IP, so it can only be accessed from the private network environment of the VPC where the load balancer is located.
CreateTime String No Resource creation time.
DeletionProtection DeletionProtectionConfig No Deletion protection setting information.
Domain String No DNS domain name.
LoadBalancerBillingConfig LoadBalancerBillingConfig No Billing configuration of a load balancing instance.
LoadBalancerId String No CLB instance ID, in the format of "alb-" followed by 8 alphanumeric characters.
LoadBalancerName String No Load balancing instance name.
LoadBalancerOperationLocks Array of LoadBalancerOperationLocksItem No Load balancer operation lock configuration.
LoadBalancerStatus String No Application CLB instance status. Valid values:

- Provisioning: Under creation.
- Active: Running.
- Configuring: The configuration is being changed.
- Deleting: Deleting.
- ProvisionFailed: Creation failed.
- ConfigureFailed: Configuration adjustment failure.
- DeletionFailed: deletion failed.
- Abnormal: abnormal status. For the specific exception reason, see the LoadBalancerOperationLocks field.
ModificationProtection ModificationProtectionInfo No Modification protection setting information.
Tags Array of TagInfo No Tag list.
VpcId String No Virtual Private Cloud (VPC) ID.

LoadBalancerAddress

IP information in the data structure of the availability zone subnet mapping for an application CLB

Used by actions: CreateLoadBalancer, DescribeLoadBalancerDetail, ModifyLoadBalancerAddressType.

Name Type Required Description
IPv4Address Array of IPAddressInfo No IPv4 address list
IPv6Address Array of IPAddressInfo No IPv6 address list

LoadBalancerBillingConfig

Billing configuration of an application CLB instance.

Used by actions: CreateLoadBalancer, DescribeLoadBalancerDetail, DescribeLoadBalancers.

Name Type Required Description
ChargeType String Yes Billing type of the instance.

Parameter value POSTPAID_BY_HOUR: pay-as-you-go.
BandwidthPackageId String No Bandwidth package ID.

LoadBalancerDetail

Load balancing details

Used by actions: DescribeLoadBalancerDetail.

Name Type Required Description
AccessLogConfig AccessLogConfig No Access log configuration.
AddressIpVersion String No IP address version. Value: IPv4 or IPv6.
AddressType String No Network address type of the application CLB instance. Valid values:

- Internet/Public: The load balancing has a public IP address, and the DNS domain name is resolved to the public IP, so it can be accessed via the public network.

- Intranet/Internal: The load balancer only has a private IP address, and the DNS domain name resolves to the private IP, so it can only be accessed from the private network environment of the VPC where the load balancer is located.
CreateTime Timestamp ISO8601 No Resource creation time in the format of yyyy-MM-ddTHH:mm:ss±hh:mm.
DeletionProtection DeletionProtectionConfig No Deletion protection setting information.
Domain String No DNS domain name.
LoadBalancerBillingConfig LoadBalancerBillingConfig No Billing configuration information of a load balancing instance.
LoadBalancerId String No CLB instance ID, in the format of "alb-" followed by 8 alphanumeric characters.
LoadBalancerName String No Instance name.

Length: 1 to 80 characters. It can contain Chinese, letters, digits, hyphens (-), forward slashes (/), half-width periods (.), and underscores (_).
LoadBalancerOperationLocks Array of LoadBalancerOperationLocksItem No Application CLB operation lock configuration.
LoadBalancerStatus String No Application CLB instance status. Valid values:

- Provisioning: Under creation.
- Active: Running.
- Configuring: The configuration is being changed.
- Deleting: deleting.
- ProvisionFailed: Creation failed.
- ConfigureFailed: Configuration adjustment failure.
- DeletionFailed: Deletion failed.
- Abnormal: abnormal status. For the specific exception reason, see the LoadBalancerOperationLocks field.
ModificationProtection ModificationProtectionInfo No Protection configuration modification information.
SecurityGroupIds Array of String No ID set of the security group bound to the application CLB instance.
Tags Array of TagInfo No Tag.
VpcId String No Virtual Private Cloud (VPC) ID.
ZoneMappings Array of ZoneMappingInfo No Mapping list of AZs and subnets. A maximum of 10 AZs can be returned. If the current region supports 2 or more AZs, at least 2 AZs are returned.

LoadBalancerOperationLocksItem

Application CLB operation lock configuration.

Used by actions: DescribeLoadBalancerDetail, DescribeLoadBalancers.

Name Type Required Description
LockReason String No The causes for the lock. Valid when LoadBalancerStatus is Abnormal.
LockType String No Lock type. Valid values:

- SecurityLocked: Security lock.

- RelatedResourceLocked: Related resource locked.

- FinancialLocked: Locked due to arrears.

- ResidualLocked: residual lock.

ModificationProtectionInfo

Modification protection status information.

Used by actions: DescribeLoadBalancerDetail, DescribeLoadBalancers.

Name Type Required Description
ModificationProtectionEnabled Boolean No Whether modification protection is enabled. Once enabled, it prevents the instance from unintended modification or deletion.
- true: enable modification protection
- false: disable modification protection
OperatorUin String No 1238716123
Reason String No Reason explanation for enabling modification protection.
Length: 1 to 255 characters. It must contain Chinese and characters from harmless strings. It can contain Chinese, letters, digits, hyphens (-), forward slashes (/), half-width periods (.), and underscores (_).

PostPayPriceInfo

Describes the price information of postpaid billing items.

Used by actions: InquirePriceCreateLoadBalancer.

Name Type Description
Discount Float Discount, such as 20.0 representing 80% off.
UnitPrice Float Unit price, in CNY.
UnitPriceDiscount Float Discounted unit price. Unit: CNY.

Price

Indicates the price of CLB

Used by actions: InquirePriceCreateLoadBalancer.

Name Type Description
InstancePrice PostPayPriceInfo Describes instance pricing. Unit: CNY/hour.
LcuPrice PostPayPriceInfo Describes the lcu price. Unit: CNY/lcu.

QuotaInfo

Query result of one quota item. Each result corresponds to a quota type. When ResourceIds is input in the request, each result also corresponds to a specific resource.

Used by actions: DescribeQuota.

Name Type Required Description
Available Integer No Current remaining available amount. Calculation method: Limit - Used. A valid value is returned only when the request parameter DisplayFields includes available. If not requested, it is not returned or is empty.
Limit Integer No Quota upper limit. Different quota types have different units. It usually represents the number of resources. For timeout-related quotas, it represents seconds.
QuotaType String No Quota type, corresponding to the values in the request parameter QuotaTypes. For the meaning of each quota type, see the QuotaTypes parameter description.
ResourceId String No Resource ID.
Used Integer No Currently used amount. A valid value is returned only when the request parameter DisplayFields includes used. If not requested, it is not returned or is empty.

RelatedListener

Listener information associated

Used by actions: DescribeSecurityPolicyRelations.

Name Type Required Description
ListenerId String No Listener ID, format: lst- followed by 8 alphanumeric characters.
ListenerPort Integer No Listener port.
ListenerProtocol String No Listener protocol.
LoadBalancerId String No CLB instance ID, in the format of "alb-" followed by 8 alphanumeric characters.

RemoveHTTPHeaderInfo

Delete HTTP Header information

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Key String Yes Key of the HTTP Header to delete. Length: 1–40 characters. Supported character sets: a-z, a-z, 0-9, -, and _.
No support for Cookie, Host, Content-Length, Connection, Upgrade, transfer-encoding, keep-alive, te, authority, x-forwarded-for, x-forwarded-proto, x-forwarded-host, x-forwarded-port, and server.

RuleAction

Rule action for forwarding

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Order Integer Yes Forward action execution sequence. Must be unique and in ascending order. Value range: 1-50000.
Type String Yes Forwarding action type. Valid values:
TargetGroup: Forward to a target group.
Redirect: Redirection.
FixedResponse: returns fixed content.
Rewrite: Rewrite.
InsertHeader: Write to HTTP Header.
RemoveHeader: Delete HTTP Header.
The forward action must include one of TargetGroup, Redirect, or FixedResponse, and the execution order must be placed last.
FixedResponseConfig FixedResponseInfo No Fixed response content configuration.
InsertHeaderConfig InsertHTTPHeaderInfo No Insert HTTP Header configuration.
RedirectConfig HTTPRedirectInfo No Redirection configuration. Except for HttpCode, other configuration cannot all use default values.
RemoveHeaderConfig RemoveHTTPHeaderInfo No Delete HTTP Header configuration.
RewriteConfig HTTPRewriteInfo No Rewrite the configuration.
TargetGroupConfig TargetGroupConfig No Forwarding target group configuration.

RuleCondition

Forwarding rule condition

Used by actions: CreateRules, DescribeRules, ModifyRulesAttributes.

Name Type Required Description
Type String Yes Forwarding condition type. Valid values:
Host: host.
Path: Path.
Header: HTTP header field.
QueryString: HTTP query string.
Method: Request method.
Cookie:Cookie.
SourceIp: Source IP.
CookieConfig Array of HTTPCookieInfo No Cookie configuration.
HeaderConfig HTTPHeaderInfo No HTTP Header configuration.
HostConfig Array of String No Host name. The host configuration can only appear once in a rule, with a length of 3 to 128 characters. It supports exact match, regular expression matching, and wildcard matching.
It cannot start or end with a half-width period (.) or underscore (_).
Exact match. Supported character sets: a-z 0-9 . - _ .
Regular expression matching. A value that begins with a tilde (~) indicates regular expression matching. Supported character sets: a-z 0-9 . - ? = ~ _ - + \ ^ * ! $ & | ( ) [ ] .
Wildcard matching. An asterisk (*) matches multiple characters, and a half-width question mark (?) matches any single character. Supported character sets: a-z 0-9 . - _ * ?.
MethodConfig Array of String No Request method. Parameter values: HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.
PathConfig Array of String No Forwarding path. Length: 1–128 characters. Supports exact matching, regular expression matching, and wildcard matching.
Exact match. Supported character sets: a-z A-Z 0-9 . - _ / = :.
For regular expression matching, it must start with ~. A ~ at the beginning means case-sensitive, and ~* at the beginning means case-insensitive. Supported character sets: a-z A-Z 0-9 . - _ / = ? ~ ^ * $ : ( ) [ ] + |.
Wildcard matching. * means multiple character wildcard, and ? means any single character wildcard. Supported character sets: a-z A-Z 0-9 . - _ / = :.
QueryStringConfig Array of HTTPQueryStringInfo No Query string configuration.
SourceIpConfig Array of String No Source IP matching configuration. CIDR format, IP address x.x.x.x/32, IP range x.x.x.x/24.

RuleHealthStatusInfo

Rule health check status

Used by actions: DescribeListenerHealthStatus.

Name Type Description
IsDefaultRule String Whether it is the default forwarding rule.
RuleId String Forwarding rule ID in the format of rule- followed by 8 alphanumeric characters.
TargetGroupHealthInfos Array of TargetGroupHealthInfo Target group health status.

RuleInput

Forwarding rule creation information

Used by actions: CreateRules.

Name Type Required Description
Actions Array of RuleAction Yes Action list of the forwarding rule.
Conditions Array of RuleCondition Yes List of forward rule conditions.
Priority Integer Yes Priority. A smaller value indicates higher priority. Must be unique. Value range: 1-10000.
Direction String No Direction of the forwarding rule. Request: request direction from the client to load balancing. Response: response direction from the real server to load balancing. Default: Request.
RuleName String No Forwarding rule name. It can contain 1–255 characters consisting of digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-).
Tags Array of TagInfo No Tag.

RuleModify

Forwarding rule modification information

Used by actions: ModifyRulesAttributes.

Name Type Required Description
Actions Array of RuleAction No Action list of the forwarding rule.
Conditions Array of RuleCondition No List of forward rule conditions.
Priority Integer No Priority. A smaller value indicates higher priority. Value range: 1-10000.
RuleId String No Forwarding rule ID in the format of rule- followed by 8 alphanumeric characters.
RuleName String No Forwarding rule name.

RuleOutput

Forwarding Rule Information

Used by actions: DescribeRules.

Name Type Description
Actions Array of RuleAction Action list of the forwarding rule.
Conditions Array of RuleCondition List of forward rule conditions.
CreateTime Timestamp ISO8601 Creation time.
Direction String Direction of the forwarding rule. Request: request direction from the client to load balancing. Response: response direction from the real server to load balancing.
ModifyTime Timestamp ISO8601 Last modification time.
Priority Integer Priority. A smaller value indicates higher priority. Value range: 1-10000.
RuleId String Forwarding rule ID in the format of rule- followed by 8 alphanumeric characters.
RuleName String Forwarding rule name.
Status String Forwarding rule status. Provisioning: under creation. Active: running. Configuring: configuration in progress.
Tags Array of TagInfo Tag list.

SecurityPolicyCapability

Encryption suite information supported by different TLS versions.

Used by actions: DescribeSecurityPolicyCapabilities.

Name Type Required Description
Ciphers Array of String No List of supported cipher suites.
TLSVersion String No Supported TLS protocol versions. Optional values include: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.

SecurityPolicyInfo

Security policy information.

Used by actions: DescribeSecurityPolicies, DescribeSystemSecurityPolicies.

Name Type Description
Ciphers Array of String List of supported cipher suites.
Supported encryption suite, which depends on the TLSVersions value.
Cipher only needs to be supported by any passed-in TLSVersions.

Description: If TLSv1.3 is selected, the Cipher list must contain ciphers supported by TLSv1.3.

Call the DescribeSecurityPolicyCapabilities API to get the supported encryption suite list.
CreateTime String Creation time.
SecurityPolicyId String Security policy ID, format: tls- followed by 8 alphanumeric characters.
SecurityPolicyName String Security policy name. It must be 2-128 English or Chinese characters, starting with letters or Chinese characters. It can consist of digits, half-width periods (.), underscores (_), and dashes (-).
Status String Security policy status. The current API most often returns Active, which means the security policy is in available status.
TLSVersions Array of String List of supported TLS protocol versions. Optional values include: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
Tags Array of TagInfo Tag information.

SecurityPolicyRelations

List of relationships between security policies and listeners.

Used by actions: DescribeSecurityPolicyRelations.

Name Type Required Description
RelatedListeners Array of RelatedListener No List of relationships between security policies and listeners.
SecurityPolicyId String No Security policy ID, format: tls- followed by 8 alphanumeric characters.

StickySessionConfig

Session persistence configuration.

Used by actions: CreateTargetGroup, DescribeTargetGroups, ModifyTargetGroupAttributes.

Name Type Required Description
StickySessionEnabled Boolean Yes Whether to enable session persistence.
- true: enabled.
- false: not enabled.
Cookie String No Custom Cookie name.
Length: 1-255 characters. It can only contain English letters and digits, and cannot be tgw_l7_tg_route. This field is a reserved field for the session persistence Cookie between target groups.
>This parameter takes effect only when StickySessionEnabled is true.
CookieTimeout Integer No Session hold time.
Value range: 1-86400. Unit: seconds.
Default value: 1000.
>This parameter takes effect only when StickySessionEnabled is true.
StickySessionType String No Session persistence type (the way cookies are handled).
- Insert (default value): Embed a Cookie. When a client accesses the backend service for the first time, the application CLB will embed a Cookie in the Return Request. The next time the client carries this Cookie in a request, load balancing will forward the request to the same backend service as last time.
- Rewrite: Rewrite the Cookie. Load balancing rewrites the user-defined Cookie. The next client request carries the Cookie, and load balancing forwards the request to the same backend service as the last request.
>This parameter takes effect only when StickySessionEnabled is true.

TagInfo

Tag information

Used by actions: CreateHealthCheckTemplate, CreateListener, CreateLoadBalancer, CreateRules, CreateSecurityPolicy, CreateTargetGroup, DescribeHealthCheckTemplates, DescribeListenerDetail, DescribeListeners, DescribeLoadBalancerDetail, DescribeLoadBalancers, DescribeRules, DescribeSecurityPolicies, DescribeSystemSecurityPolicies, DescribeTargetGroups.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes Tag value

TargetGroupConfig

Target group configuration

Used by actions: CreateListener, CreateRules, DescribeListenerDetail, DescribeRules, ModifyListenerAttributes, ModifyRulesAttributes.

Name Type Required Description
TargetGroups Array of TargetGroupTuple Yes Target group list.
TargetGroupStickySession TargetGroupStickySession No Session persistence between target groups

TargetGroupHealthInfo

Target group health check status

Used by actions: DescribeListenerHealthStatus.

Name Type Description
HealthCheckEnabled Boolean Whether to enable the health check.
TargetGroupId String Target group ID in the format of lbtg- followed by 8 alphanumeric characters.
TargetHealthStatusInfos Array of TargetHealthStatusInfo List of service health check statuses.
Type String Forward action type. Valid values:
TargetGroup: Forward to a target group.
Redirect: Redirection.
FixedResponse: returns fixed content.
Rewrite: Rewrite.
InsertHeader: Write to an HTTP header.
RemoveHeader: Delete HTTP Header.
Forward action must include one of TargetGroup, Redirect, or FixedResponse, and the execution order is placed last.

TargetGroupOutput

Brief information output parameters of the target group

Used by actions: DescribeTargetGroups.

Name Type Description
CreateTime Timestamp ISO8601 Creation time.
HealthCheckConfig HealthCheckConfig Health check configuration.
KeepaliveEnabled Boolean Whether to enable long connections.
Protocol String Backend service protocol type. Value:
- HTTP (default): support binding HTTP and HTTPS listeners
- HTTPS: support binding HTTPS listeners
- GRPC: support binding HTTPS listeners
- GRPCS: support binding HTTPS listeners
RelatedLoadBalancersCount Integer Number of load balancers associated with the target group.
SchedulerAlgorithm String Scheduling algorithm.
StickySessionConfig StickySessionConfig Session persistence configuration.
Tags Array of TagInfo Tag.
TargetGroupId String Target group ID in the format of lbtg- followed by 8 alphanumeric characters.
TargetGroupName String Target group name. Defaults to the target group ID. It contains 1–255 characters, consisting of digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-).
TargetGroupStatus String Status of the target group. Valid values:
- Provisioning: Under creation.
- ProvisionFailed: Creation failed.
- Active: Running.
- Configuring: configuration changing.
TargetType String Target group type. Valid values:
- Instance: Cvm server type or Eni type
VpcId String Virtual Private Cloud (VPC) ID.

TargetGroupStickySession

Session persistence between target groups

Used by actions: CreateListener, DescribeListenerDetail, ModifyListenerAttributes.

Name Type Required Description
Enabled Boolean Yes Whether to enable session persistence. Off by default.
Timeout Integer No Timeout period in seconds. Value range: 1-86400. Default value: 1000.

TargetGroupTuple

Basic target group configuration

Used by actions: CreateListener, DescribeListenerDetail, ModifyListenerAttributes.

Name Type Required Description
TargetGroupId String Yes Target group ID in the format of lbtg- followed by 8 alphanumeric characters.
Weight Integer No Weight. Value range: [0, 100]. Default value: 10.

TargetHealthStatusInfo

Service health status information

Used by actions: DescribeListenerHealthStatus.

Name Type Description
Status String Backend service health status. If DescribeListenerHealthStatus returns only unhealthy backends, this value is UnHealthy.
TargetId String Backend service instance ID. For a CVM instance, the format is "ins-" followed by 8 alphanumeric characters.
TargetIp String Backend target service IP.
TargetPort Integer Backend server port.

TargetOutput

Backend service output parameter.

Used by actions: DescribeTargetGroupTargets.

Name Type Description
EniId String Network-interface ID.
Port Integer Port used by the real server. Value range: 1-65535.
TargetId String Backend service instance ID. For a CVM instance, the format is "ins-" followed by 8 alphanumeric characters.
TargetIp String Backend service IP. At least one of TargetIp and TargetId is required.

- When the server group is of the Instance type, this parameter is the primary or secondary private IP of Eni.
TargetName String Backend service name. Currently, only CVM backend services return a valid name.
TargetStatus String Backend service status. Valid values:
- Adding: Adding.
- Active: available status.
- Configuring: configuration in progress.
- Removing: removing.
TargetType String Backend service type.
Weight Integer Weight of the backend service. Value range: 0-100. Default value: 100. If the weight is set to 0, no request will be forwarded to this backend service.

TargetToAdd

Backend service added to the target group

Used by actions: AddTargetsToTargetGroup.

Name Type Required Description
Port Integer Yes Port used by the real server. Value range: 1-65535.

>When the targetType value of the target group is Instance, this parameter is required.
TargetIp String Yes Backend service IP. At least one of TargetIp and TargetId is required.

- When the server group is of the Instance type, this parameter is the primary or secondary private IP of Eni.
Weight Integer No Weight of the backend service. Value range: 0-100. Default value: 10. If the weight is set to 0, no request will be forwarded to this backend service.

TargetToModify

Backend service that needs to be modified.

Used by actions: ModifyTargetsInTargetGroup.

Name Type Required Description
TargetIp String Yes Backend service IP. At least one of TargetIp and TargetId is required.

- When the server group is of the Instance type, this parameter is the primary or secondary private IP of Eni.
Port Integer No Port used by the real server. Value range: 1-65535.

>When the targetType value of the target group is Instance, this parameter is required.
Weight Integer No Weight of the backend service. Value range: 0-100. If the weight is set to 0, the request will not be forwarded to this backend service.

TargetToRemove

Backend service removed from the target group.

Used by actions: RemoveTargetsFromTargetGroup.

Name Type Required Description
Port Integer Yes Port used by the real server. Value range: 1-65535.

>When the targetType value of the target group is Instance, this parameter is required.
TargetIp String Yes Backend service IP. At least one of TargetIp and TargetId is required.

- When the server group is of the Instance type, this parameter is the primary or secondary private IP of Eni.

XForwardedForConfig

Forwarding configuration

Used by actions: CreateListener, DescribeListenerDetail, DescribeListeners, ModifyListenerAttributes.

Name Type Required Description
XForwardedForAlbIdEnabled Boolean No Whether to get the CLB instance ID through the ALB-ID header field.
- true: Yes.
- false: No.
XForwardedForClientSrcPortEnabled Boolean No Whether to obtain the port of the client accessing the load balancing instance through the X-Forwarded-Client-srcport header field.
- true: Yes.
- false: No.
XForwardedForHostEnabled Boolean No Whether to enable obtaining the client domain name that accesses the load balancing instance through the X-Forwarded-Host header field.
- true: yes.
- false: No.
XForwardedForMode String No Specify how to handle the X-Forwarded-For (XFF) HTTP header field.
- append: Append mode (default). Appends the real IP of the client to the end of the X-Forwarded-For header, retaining the original XFF link information.
-remove: Deletion mode. Remove the X-Forwarded-For header field and do not pass this header to the real server.
- passthrough: Passthrough mode. The X-Forwarded-For header remains unchanged and is directly passed through to the real server without any modification.
XForwardedForPortEnabled Boolean No Whether to obtain the listening port of the load balancing instance through the X-Forwarded-Port header field.
- true: yes.
- false: No.
XForwardedForProtoEnabled Boolean No Whether to obtain the listening protocol of the load balancing instance through the X-Forwarded-Proto header field.
- true: yes.
- false: No.
XTencentClientIDNEnabled Boolean No Whether to access the issuer of the client certificate $ssl_client_i_dn through the X-Tencent-Client-IDN header.
- true: yes.
- false: No.
XTencentClientSDNEnabled Boolean No Whether to access the subject of the client certificate $ssl_client_s_dn through the X-Tencent-Client-SDN header.
- true: yes.
- false: No.
XTencentClientSerialEnabled Boolean No Whether to access the serial number $ssl_client_serial of the client certificate through the X-Tencent-Client-Serial header.
- true: yes.
- false: No.
XTencentClientVerifyEnabled Boolean No Access the verification result $ssl_client_verify of the client certificate through the X-Tencent-Client-Verify header.
- true: yes.
- false: No.

Zone

Availability zone information

Used by actions: DescribeZones.

Name Type Description
LocalName String AZ name.
ZoneId String AZ ID.
ZoneStatus String Availability zone status

ZoneMappingInfo

AZ and subnet mapping structure

Used by actions: DescribeLoadBalancerDetail.

Name Type Required Description
SubnetId String Yes

Subnet ID.
ZoneId String Yes

Availability zone ID. Maximum support for adding 10 availability zones. If the current region supports 2 or more availability zones, at least 2 availability zones need to be added.
You can obtain the availability zone information corresponding to the availability zone ID by calling the DescribeZones API.
LoadBalancerAddress LoadBalancerAddress No

Load balancing VIP/EIP information
Status String No

Availability zone status. Value:

  • Active: Running.
  • Stopped: Stopped.
  • Shifted: Has been removed.
  • Starting: Starting.
  • Stopping: Stopping.

ZoneMappingsItem

AZ and subnet mapping structure for purchase or modification

Used by actions: CreateLoadBalancer, ModifyLoadBalancerAddressType.

Name Type Required Description
SubnetId String Yes

Subnet ID.
ZoneId String Yes

Availability zone ID. A maximum of 10 availability zones can be added. If the current region supports 2 or more availability zones, at least 2 availability zones are required.
You can obtain the availability zone information corresponding to the availability zone ID through the DescribeZones API.
LoadBalancerAddress LoadBalancerAddress No

ID of the EIP bound to the public network instance.
이전 주제: AddTargetsToTargetGroup다음 주제: Error Codes

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백

키워드로 검색
    Enter keywords to search documentation