Tenant Cloud Network Cloud Load Balancer Data structure

Data structure

Last Updated At: 2026-08-02 00:05:23

RewriteLocationMap

Redirection relationship between forwarding rules

Referenced by the following interfaces: DeleteRewrite, ManualRewrite

name required NULL allowed type description
SourceLocationId yes no String Source forwarding rule ID
Example: loc-i82kji93
TargetLocationId yes no String Target forwarding rule ID for redirection
Example: loc-lavxji93
RewriteCode no no Uint64 Redirection status code. Valid values: 301, 302, and 307.
Example: 302
TakeUrl no no Bool Whether the matched URL is carried in redirection. This parameter is required when you configure RewriteCode.
Example: true
SourceDomain no no String Source domain name of redirection, which must be the domain name corresponding to SourceLocationId. This parameter is required when you configure RewriteCode.
Example: source.com

RuleOutput

HTTP/HTTPS listener forwarding rule (output)

Referenced by the following interfaces: DescribeListeners, DescribeRewrite

name required NULL allowed type description
LocationId no no String Forwarding rule ID
Example: loc-jkdsix03
Domain yes yes String Domain name of the forwarding rule
Example: www.realdomain.com
Url yes yes String Path of the forwarding rule.
Example: /url1
SessionExpireTime no no Int64 Session persistence Duration
Example: 0
HealthCheck no yes HealthCheck Health check information
Example:View
Certificate no yes CertificateOutput Certification information
Example:View
Scheduler no no String Request forwarding method of the rule
Example: WRR
ListenerId yes no String ID of the listener to which the forwarding rule belongs
Example: lbl-8cnlji93
RewriteTarget yes yes RewriteTarget Redirection target information of the forwarding rule
Example:View
HttpGzip yes no Bool Whether to enable gzip
Example: true
BeAutoCreated yes no Bool Whether the forwarding rule is automatically created
Example: false
DefaultServer yes no Bool Whether to set as the default domain name
Example: true
Http2 yes no Bool Whether to enable Http2
Example: false
ForwardType yes no String Forwarding protocol between CLB and the real server
Example: HTTP
CreateTime yes no String Forwarding rule creation time
Example: 2024-01-22 14:36:12
TargetType yes no String Real server type
Example: NODE
TargetGroup yes yes BasicTargetGroupInfo Basic information of a bound target group. This field will be returned if a target group is bound to a rule.
Example:View
WafDomainId yes yes String WAF instance ID
Example: ""
QuicStatus no yes String QUIC status
Example: QUIC_INACTIVE
TrpcCallee no yes String TRPC callee server route, which takes effect when ForwardType is TRPC
Example: ""
TrpcFunc no yes String TRPC calling service API, which takes effect when ForwardType is TRPC
Example: ""

ConfigListItem

Configuration

Referenced by the following interfaces: DescribeCustomizedConfigList

name required NULL allowed type description
UconfigId yes no String Configuration ID
Example: pz-di3kx902
ConfigType yes no String Configuration Type
Example: CLB
ConfigName yes yes String Configuration name
Example: cm-1
ConfigContent yes no String Configuration
Example: add_header aaa bbb;\r\n
CreateTimestamp yes no String Configuration creation time
Example: 1702903612
UpdateTimestamp yes no String Configuration modification time
Example: 1702903612

FunctionInfo

Serverless Cloud Function (SCF) information

Referenced by the following interfaces: DescribeTargetHealth, DescribeTargets

name required NULL allowed type description
FunctionNamespace no yes String Function namespace
Example: default
FunctionName no yes String Function Name
Example: function-1
FunctionQualifier no yes String Function version name or alias
Example: jd9x30xs
FunctionQualifierType no yes String FunctionQualifier identifier type. Valid values: VERSION and ALIAS
Example: VERSION

LBChargePrepaid

Attributes for monthly subscription configuration of a CLB instance

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, InquiryPriceCreateLoadBalancer, ModifyLoadBalancerAttributes

name required NULL allowed type description
RenewFlag no yes String Renewal type. AUTO_RENEW: Automatic renewal; MANUAL_RENEW: Manual renewal
Example: MANUAL_RENEW
Period no yes Int64 Purchase period. Unit: month
Example: 100

CertIdRelatedWithListener

Certificate ID and the list of CLB listeners bound to the certificate.

Referenced by the following interfaces: DescribeListenerListByCertId

name required NULL allowed type description
CertId yes no String Certificate ID
Example: j9djk23x
Listeners yes no Array of CertListener List of listeners bound to the certificate.
Example:View

ItemPrice

Describe pricing information of an item

Referenced by the following interfaces: InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer

name required NULL allowed type description
UnitPrice yes yes Float Postpaid unit price.
Example: 10
ChargeUnit yes yes String Subsequent billing unit. Value range:
HOUR: Billing by hour. This billing unit is involved in scenarios with the billing type set to POSTPAID_BY_HOUR or BANDWIDTH_POSTPAID_BY_HOUR.
GB: Billing by traffic in GB. This billing unit is involved in scenarios with the billing type set to TRAFFIC_POSTPAID_BY_HOUR.
Example: HOUR
OriginalPrice yes yes Float Original prepaid price.
Example: 50
DiscountPrice yes yes Float Discounted prepaid price.
Example: 50
UnitPriceDiscount yes yes Float Discounted postpaid unit price.
Example: 10
Discount yes yes Float Discount, such as 20.0 representing 80% off.
Example: 100

Price

Indicates the price of CLB

Referenced by the following interfaces: InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer

name required NULL allowed type description
InstancePrice yes yes ItemPrice Describes the instance pricing.
Example:View
BandwidthPrice yes yes ItemPrice Describes the network pricing.
Example:View

BindDetailItem

Binding relationship, including listener name, protocol, URL, and vport.

Referenced by the following interfaces: DescribeCustomizedConfigAssociateList

name required NULL allowed type description
LoadBalancerId yes no String ID of the CLB instance bound to the configuration
Example: lb-4d2yji93
ListenerId yes yes String ID of the listener bound to the configuration
Example: lbl-4apyji93
Domain yes yes String Domain name bound to the configuration
Example: foo.net
LocationId yes yes String Rule bound to the configuration
Example: loc-jdhsji93
ListenerName yes yes String Listener name
Example: lbl-1
Protocol yes yes String Listener protocol
Example: HTTP
Vport yes yes Int64 Listener port
Example: 80
Url yes yes String Location URL
Example: /loc1
UconfigId yes yes String Configuration ID
Example: pz-h98ds9dx

TargetCountForLoadBalancer

CLB instance and the total number of real servers bound to it

Referenced by the following interfaces: DescribeTargetCountForLoadBalancers

name required NULL allowed type description
LoadBalancerId yes no String CLB ID
Example: lb-di3kx902
TargetCount yes no Uint64 Total number of real servers bound to the CLB instance
Example: 2

TagInfo

CLB tag information

Referenced by the following interfaces: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc

name required NULL allowed type description
TagKey yes no String Tag key
Example: key-djx983xs
TagValue yes no String Tag value
Example: value-djx983xs

TargetHealth

Describes the health information of a target

Referenced by the following interfaces: DescribeTargetHealth

name required NULL allowed type description
IP yes no String Private network IP of target
Example: '10.0.0.1'
Port yes no Int64 Port bound to the target
Example: 80
HealthStatus yes no Bool Current health status. true: Healthy; false: Unhealthy (Check not started/Checking/Unknown status). CLB forwards traffic to a target only when the target is healthy (and with a weight greater than 0).
Example: true
TargetId yes no String Target instance ID. For example, ins-j9x73ko1.
Example: 'ins-j9x73ko1'
HealthStatusDetial yes no String Detailed information about the current health status. Alive: Healthy; Dead: Exceptional; Unknown: Check not started/Checking/Unknown status.
Example: 'Alive'

ZoneInfo

AZ information

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, DescribeMasterZones

name required NULL allowed type description
ZoneId yes yes Uint64 Unique ID of the AZ in numeric form, such as 100001
Example: 100001
Zone yes yes String Unique ID of the AZ in string format. For example: ap-region1-1.
Example: ap-region1-1
ZoneName yes yes String AZ name. For example, AZ 1.
Example: AZ 1
ZoneRegion no yes String Region of the AZ
Example: ap-region1
LocalZone no yes Bool Whether the AZ is a LocalZone
Example: false
EnableShared no yes Bool Whether the availability zone has available shared clusters.
Example: true
EnableL4SetLabels no yes Array of String Tag of the available Layer-4 cluster for the availability zone.
Example: ["l4-label"]
AvailableIsps no no Array of AvailableIspInfo Information set of available ISPs for the availability zone.
Example:View

CertificateOutput

Certificate information

Referenced by the following interfaces: DescribeListeners, DescribeRewrite

name required NULL allowed type description
SSLMode yes no String Authentication type. UNIDIRECTIONAL: One-way authentication; MUTUAL: Mutual authentication
Example: UNIDIRECTIONAL
CertId yes no String Server certificate ID. (Compatible with earlier versions. Default: RSA certificate)
Example: ALZji93p
CertCaId yes yes String Client certificate ID.
Example: 4Ihji936
SmCertId yes yes String Server SM certificate ID.
Example: fds2dgsx
EccCertId yes yes String ID of the server ECC certificate.
Example: fds2dgsx

IspSet

ISP information description

Referenced by the following interfaces: DescribeIspInfo

name required NULL allowed type description
Id yes no Uint64 ISP ID
Example: 2
Type yes no String ISP type
Example: CMCC
Name yes no String ISP name
Example: Move
IspStatus yes no Uint64 ISP IPv4 status
Example: 1
IspStatusIPv6 yes no Uint64 ISP IPv6 status
Example: 1
V4alias no no String ISP v4 alias
Example: Move
V6alias no no String ISP v6 alias
Example: Move

RuleTargets

Information of the real server bound to a forwarding rule under an HTTP/HTTPS listener

Referenced by the following interfaces: DescribeTargets

name required NULL allowed type description
LocationId yes no String Forwarding rule ID
Example: loc-i82kji93
Domain yes no String Domain name of the forwarding rule
Example: wagnzha.com
Url yes no String Path of the forwarding rule.
Example: /url1
Targets yes yes Array of Backend Real server information
Example:View
FunctionTargets no yes Array of FunctionTarget Backend cloud function information. (This parameter is not supported on Private Cloud.)
Example:View

Backend

Details of a real server bound to a listener

Referenced by the following interfaces: DescribeTargets

name required NULL allowed type description
Type yes no String Real server type. Valid values: CVM, BMS, and ENI
Example: CVM
InstanceId yes no String Unique backend service ID. For example, ins-gx3gj9x7.
Example: ins-gx3gj9x7
Port yes no Int64 Real server listening port
Example: 80
Weight yes no Int64 Forwarding weight of a real server. Value range: [0, 100]. Default: 10.
Example: 10
PublicIpAddresses yes yes Array of String Public network IP of the real server
Example: 1.1.1.1
PrivateIpAddresses yes yes Array of String Private network IP of the real server
Example: 10.0.0.1
InstanceName yes yes String Instance name of the real server
Example: cvm-1
RegisteredTime yes yes String Real server binding time
Example: 2021-12-29 14:38:50
EniId yes yes String Unique ENI ID. For example, eni-j9x7gx3g.
Example: eni-j9x7gx3g

TargetRegionInfo

Information of the real server bound to a CLB instance, including region and network to which it belongs.

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, ModifyLoadBalancerAttributes

name required NULL allowed type description
Region yes no String Target region. For example, ap-region1.
Example: ap-region1
VpcId yes no String Network of the target. For example, vpc-gx3gj9x7 (for VPCs) and 0 (for classic networks).
Example: vpc-6kogji93

BatchTarget

Batch binding type

Referenced by the following interfaces: BatchDeregisterTargets, BatchRegisterTargets

name required NULL allowed type description
ListenerId yes no String Listener ID
Example: lbl-2gasji93
InstanceId no no String Node ID
Example: ins-1vfjji93
EniIp no no String ENI IP
Example: 10.0.X.X
Port yes no Int64 Bound port
Example: 80
Weight no no Int64 Node weight. Value range: [0, 100]. Defaults to 10 if not present during binding.
Example: 10
LocationId no no String Layer-7 rule ID
Example: lbl-4apyji93

HealthCheck

Health check information.
Note: This is a custom check parameter. Currently, it is supported only in a few regions (You need to submit a ticket if you need to use this API).

Referenced by the following interfaces: CreateListener, CreateRule, DescribeListeners, DescribeRewrite, ModifyListener, ModifyRule

name required NULL allowed type description
HealthSwitch no no Int64 Whether to enable health check. 1: Enable; 0: Disable.
Example: 0
TimeOut no yes Int64 Response timeout duration for health checks (applicable only to layer-4 listeners). Value range: 2-60. Default: 2. Unit: sec. Response timeout duration should be less than the check interval.
Example: 2
IntervalTime no yes Int64 Health check interval. Default: 5. Value range: 5-300. Unit: sec.
Example: 5
HealthNum no yes Int64 Healthy threshold. Default: 3, indicating that if a forwarding is found healthy three consecutive times, it is considered to be normal. Value range: 2-10. Unit: times.
Example: 3
UnHealthNum no yes Int64 Unhealthy threshold. Default: 3, indicating that if a forwarding is found unhealthy three consecutive times, it is considered to be exceptional. Value range: 2-10. Unit: times.
Example: 3
HttpCode no yes Int64 Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default: 31.
1: Return code 1xx for healthy status. 2: Return code 2xx for healthy status. 4: Return code 3xx for healthy status. 8: Return code 4xx for healthy status. 16: Return code 5xx for healthy status. If you want multiple return codes to represent healthy status, sum up the corresponding values. Note: The HTTP health checks of TCP listeners only support specifying one health check status code.
Example: 8
HttpCheckPath no yes String Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
Example: /url1
HttpCheckDomain no yes String Health check domain name (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
Example: www.helthcheck.com
HttpCheckMethod no yes String Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Default: HEAD. Valid values: HEAD and GET.
Example: HEAD
CheckPort no yes Int64 A custom check parameter, representing the health check port, which is the port of the real server by default. Unless you want to specify a port, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners)
Example: 8000
ContextType no yes String Custom detection parameters. When the value of the health check protocol CheckType is set to CUSTOM, this field is required and represents the input format for the health check. Valid values: HEX or TEXT. HEX indicates binary data, while TEXT indicates text data, which only supports visible ASCII characters. When the value is HEX, the characters of SendContext and RecvContext can only be selected from 0123456789ABCDEF, and the length should be an even number. (Applicable only to TCP/UDP listeners.)
Example: TEXT
SendContext no yes String A custom check parameter, which is required if the value of CheckType (health check protocol) is CUSTOM. This parameter represents the content of the request sent by the health check. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.)
Example: request-info
RecvContext no yes String A custom check parameter, which is required if the value of CheckType (health check protocol) is CUSTOM. This parameter represents the result returned by the health check. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.)
Example: response-info
CheckType no yes String Custom detection parameters. Protocol used for health check: TCP 
HttpVersion no yes String A custom check parameter, representing the HTTP version of the real server, which is required if the value of CheckType is HTTP. Valid values: HTTP/1.0 and HTTP/1.1. (Applicable only to TCP listeners)
Example: HTTP/1.1

CertIdRelatedWithLoadBalancers

Certificate ID and the list of CLB instances associated with the certificate ID

Referenced by the following interfaces: DescribeLoadBalancerListByCertId

name required NULL allowed type description
CertId yes no String Certificate ID
Example: j9sl3xs2
LoadBalancers yes yes Array of LoadBalancer List of CLB instances associated with the certificate
Example:View

SubQuota

Sub-account quota description

Referenced by the following interfaces: SetSubUinQuotas

name required NULL allowed type description
SubUin yes no String Sub-account UIN
Example: 110000004918
Type yes no Uint64 Quota type (4: Public network instance quota; 7: Private network instance quota)
Example: 4
Quota yes no Uint64 Quota value
Example: 10

Filter

Filter conditions

Referenced by the following interfaces: DescribeListeners, DescribeLoadBalancers

name required NULL allowed type description
Name yes no String Filter name
Example: loadbalancerIds
Values yes no Array of String Filter value array
Example: ["lb-di3kx902"]

MasterZoneInfo

Primary AZ information

Referenced by the following interfaces: DescribeMasterZones

name required NULL allowed type description
ZoneId yes yes Uint64 Unique ID of the AZ in numeric form, such as 100001
Example: 50010001
Zone yes yes String Unique ID of the AZ in string format. For example: ap-region1-1.
Example: 50010001
ZoneName yes yes String AZ name. For example, AZ 1.
Example: 50010001
BackupZoneSet yes yes Array of ZoneInfo List of secondary AZs
Example:View
LBType no yes String Returned availability zone type. Valid values: open, internal.
Example: open
AvailableIsps no yes Array of AvailableIspInfo Returned availability status of each ISP.
Example:View

Target

Forwarding target, namely, a real server bound to the CLB instance

Referenced by the following interfaces: BatchModifyTargetWeight, DeregisterTargets, ModifyTargetPort, ModifyTargetWeight, RegisterTargets

name required NULL allowed type description
Type no yes String Real server type. Valid values: CVM (Cloud Virtual Machine), ENI (Elastic Network Interface), and BMS (Bare Metal Server). Currently, this parameter does not take effect as an input parameter.
Example: CVM
InstanceId no yes String Unique ID of a CVM instance, which is required when you bind a CVM instance. This parameter can be obtained from the InstanceId field in the response of the DescribeInstances API.
Note: One and only one of the InstanceId, EniIp, and InstanceBmsId parameters must be provided.
Example: ins-di3kx902
Port yes yes Int64 Real server listening port
Example: 80
Weight no no Int64 Forwarding weight of a real server. Value range: [0, 100]. Default: 10.
Example: 10
EniIp no yes String ENI IP, which is required when an ENI is bound. The ENI must first be bound to CVM before it can be bound to a CLB instance. Note: One and only one of the InstanceId, EniIp, and InstanceBmsId parameters must be provided. Note: To bind an ENI, you need to submit a ticket to add it to the allowlist.
Example: x.x.x.x
InstanceBmsId no yes String Unique ID of a BMS instance, which is required when you bind a BMS instance. This parameter can be obtained from the bmsId field in the response of the DescribeInstances API of the BMS instance.
Note: One and only one of the InstanceId, EniIp, and InstanceBmsId parameters must be provided. Binding bms and cvm or eni simultaneously is not supported.
Example: bms-di3kx902x

ExtraInfo

Reserved. Generally unnecessary for users to concern.

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc

name required NULL allowed type description
ZhiTong yes yes Bool Whether to enable VIP Direct Connect
Example: 0
TgwGroupName yes yes String TgwGroup name
Example: tg-1

InternetAccessible

Network billing mode, maximum outbound bandwidth

Referenced by the following interfaces: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, ModifyLoadBalancerAttributes

name required NULL allowed type description
InternetChargeType no yes String TRAFFIC_POSTPAID_BY_HOUR: Postpaid by traffic on an hourly basis; BANDWIDTH_POSTPAID_BY_HOUR: Postpaid by bandwidth on an hourly basis;
BANDWIDTH_PACKAGE: Billed by bandwidth package (Currently, this billing mode is supported only when a ISP is specified.)
Example: BANDWIDTH_POSTPAID_BY_HOUR
InternetMaxBandwidthOut no yes Int64 Maximum outbound bandwidth. Unit: Mbps. Value range: 0-65535. This parameter takes effect only on public network CLB. Default: 10
Example: 1
BandwidthpkgSubType no yes String Bandwidth package type. For example, SINGLEISP. This parameter is not supported on Private Cloud.
Example: SINGLEISP

QuotaData

Description of the root account and sub-account quotas

Referenced by the following interfaces: DescribeSubUinQuotas

name required NULL allowed type description
Type yes no Int64 Quota type (4: Public network instance quota; 7: Private network instance quota)
Example: 4
UsedQuota yes no Int64 Used quota
Example: 1
CurQuota yes no Int64 Root account quota
Example: 3
SubQuota yes yes Array of SubQuotaRsp Quota list for this type of sub-account
Example:View
SubUsedTotalQuota yes yes Int64 Total quota used by the sub-account
Example: 5

RewriteTarget

Redirection target information

Referenced by the following interfaces: DescribeListeners, DescribeRewrite

name required NULL allowed type description
TargetListenerId yes yes String Listener ID of the redirection target
Note: This field may return null, indicating no redirection.
Example: lbl-di3kx902
TargetLocationId yes yes String Forwarding rule ID of the redirection target
Note: This field may return null, indicating no redirection.
Example: loc-di3kx902
RewriteCode yes yes Int64 Redirect status code
Example: 302
TakeUrl yes yes Bool Whether the matched URL is carried in redirection
Example: true
RewriteType yes yes String Redirection type. Manual: Manual redirection; Auto: Automatic redirection
Example: Auto

RuleHealth

Health check status of a forwarding rule

Referenced by the following interfaces: DescribeTargetHealth

name required NULL allowed type description
LocationId yes no String Forwarding rule ID
Example: loc-di3kx902
Domain yes yes String Domain name of the forwarding rule
Example: foo.net
Url yes yes String URL of the forwarding rule
Example: /url1
Targets yes yes Array of TargetHealth Health check status of the real server bound to this rule
Example:View
FunctionTargets no yes Array of FunctionTarget Backend cloud function information. (This parameter is not supported on Private Cloud.)
Example:View

RsWeightRule

Modify the data type of a node weight

Referenced by the following interfaces: BatchModifyTargetWeight

name required NULL allowed type description
ListenerId yes no String CLB listener ID
Example: lb-cuxwji93
LocationId no no String Forwarding rule ID, required for layer-7 rules and not required for layer-4 rules
Example: loc-o8cnji93
Domain no no String Domain name of the target rule. This parameter will not take effect when the LocationId parameter is provided.
Example: www.demo.example.com
Url no no String The URL of the target rule. This parameter will not take effect when the LocationId parameter is provided.
Example: /index
Targets yes no Array of Target The list of real servers for which the weights are to be modified
Example:View
Weight no no Int64 New forwarding weight of a real server. Value range: 0-100.
Example: 10

AvailableIspInfo

Availability status of ISPs for the availability zone.

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, DescribeMasterZones

name required NULL allowed type description
Isp yes no String Operator
Example: Private Network
IspAlias no no String ISP alias
Example: Private Network
EnableShared yes no Bool Whether there are shared cluster resources.
Example: true
EnableL4SetLabels no no Array of String Tag of the available Layer-4 cluster.
Example: ["l4-label1"]
AvailableVpcIds no no Array of String VPC available for the IPv6-BGP mode.
Example: ["vpc-xh39xy45"]

LoadBalancerHealth

CLB instance health check status

Referenced by the following interfaces: DescribeTargetHealth

name required NULL allowed type description
LoadBalancerId yes no String CLB instance ID
Example: lb-di3kx902
LoadBalancerName yes yes String CLB Instance Name
Example: lb-1
Listeners yes yes Array of ListenerHealth Listener list
Example:View

LoadBalancer

CLB instance information

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc

name required NULL allowed type description
LoadBalancerId no no String CLB instance ID.
Example: lb-fwzz9i3x
LoadBalancerName no no String CLB instance name.
Example: Name
LoadBalancerType no no String CLB instance network type:
OPEN: Public network; INTERNAL: Private network.
Example: OPEN
Forward no no Uint64 Load balancer type identifier. 1: CLB; 0: Classic CLB.
Example: 1
Domain no yes String Domain name of the CLB instance, provided only for public network Classic CLB instances
Example: www.aaa.com
LoadBalancerVips no yes Array of String List of VIPs of a CLB instance.
Example: [43.23.46.32]
Status no yes Uint64 CLB instance status. Valid values:
0: Creating; 1: Normal running.
Example: 1
CreateTime no yes String CLB instance creation time
Example: 2020-12-08 08:00:00
StatusTime no yes String Last status transition time of the CLB instance.
Example: 2020-12-08 08:00:00
ProjectId no no Uint64 The ID of the project to which the CLB instance belongs. 0: Default project.
Example: 0
VpcId no yes String VPC ID
Example: vpc-mj65xvs2
OpenBgp no yes Uint64 Anti-DDoS Pro identifier for CLB. 1: CLB with Anti-DDoS Pro; 0: CLB without Anti-DDoS Pro.
Example: 0
Snat no yes Bool Private network Classic CLB instances before December 2016 had SNAT enabled.
Example: false
Isolation no yes Uint64 0: Not isolated; 1: Isolated.
Example: 0
Log no yes String User-enabled log information. Only public network CLB instances that have an HTTP or HTTPS listener can generate logs.
Example:  null
SubnetId no yes String Subnet of the CLB instance (applicable only to VPC-type CLB instances on private networks)
Example: subnet-lzj3cj09
Tags no yes Array of TagInfo CLB instance tag information
Example:View
SecureGroups no yes Array of String Security group of the CLB instance
Example: sg-hx6djv9x
TargetRegionInfo no yes TargetRegionInfo Basic information of real servers bound to the CLB instance
Example:View
AnycastZone no yes String Anycast CLB release domain. For non-anycast CLB, this field returns an empty string.
Example:  null
AddressIPVersion no yes String IP version. Valid values: ipv4 and ipv6
Example: ipv4
NumericalVpcId no yes Uint64 VPC ID in numerical format
Example: 77599
VipIsp no yes String ISP of the CLB IP address
Example: BGP
MasterZone no yes ZoneInfo Primary Availability Zone
Example:View
BackupZoneSet no yes Array of ZoneInfo Secondary Availability Zone
Example:View
IsolatedTime no yes String CLB instance isolation time
Example: 2022-02-12 12:15:08
ExpireTime no yes String CLB instance expiration time, applicable only to prepaid CLB
Example: 2021-02-12 12:15:08
ChargeType no yes String CLB instance billing type
Example: POSTPAID_BY_HOUR
NetworkAttributes no yes InternetAccessible CLB instance network attributes
Example:View
PrepaidAttributes no yes LBChargePrepaid Prepaid billing attributes of a CLB instance
Example:View
LogSetId no yes String Log set ID of Cloud Log Service (CLS) for CLB
Example: c32fc818-e984-414a-b8f5-3985b4c5
LogTopicId no yes String Log topic ID of Cloud Log Service (CLS) for CLB
Example: c32fc818-e984-414a-b8f5-3985b4c5
AddressIPv6 no yes String IPv6 address of the CLB instance
Example: 2402:4e00:1000:4e00:0:920b:5519:d96d
ExtraInfo no yes ExtraInfo Reserved. Generally unnecessary for users to concern.
Example:View
IsDDos no yes Bool Whether an Anti-DDoS Pro instance can be bound
Example: false
ConfigId no yes String Custom configuration IDs of CLB instances
Example: pz-jdohxk30x
LoadBalancerPassToTarget no yes Bool Whether the real server allows traffic from CLB
Example: false
ExclusiveCluster no yes ExclusiveCluster Exclusive cluster on the private network
Example:View
IPv6Mode no yes String This field is meaningful when the IP address version is ipv6. Valid values: IPv6Nat64 and IPv6FullChain
Example: IPv6FullChain
SnatPro no yes Bool Whether to enable SnatPro
Example: true
SnatIps no yes Array of SnatIp SnatIp list after SnatPro CLB is enabled
Example:View
SlaType no yes String Performance guarantee specification
Example:  null
IsBlock no yes Bool Whether VIP is blocked
Example: false
VipIspId no yes Int64 ID of the ISP of the CLB IP address
Example: 5
VipIspName no yes String ISP of the CLB IP address
Example: BGP
AttributeFlags no yes Array of String Attribute tag list
Example: DeleteProtect
TgwSetLabels no yes Array of String Parameter specific to Private Cloud. Layer-4 cluster tag bound to the CLB instance.
Example: ["l4-label"]
StgwSetLabels no yes Array of String Parameter specific to Private Cloud. Layer-7 cluster tag bound to the CLB instance.
Example: ["l7-label"]
Zones no yes Array of String VPC-based private network CLB. AZ where the rule is in proximity access mode
Example: null
NfvInfo no yes String Whether CLB is NFV. Empty: No; l7nfv: NFV for layer 7.
Example: null
IsBlockTime no yes String Blocking or unblocking time
Example: 2021-02-12 12:15:08
HealthLogSetId no yes String Health check log set ID of Cloud Log Service (CLS) for CLB
Example: c32fc818-e984-414a-b8f5-3985b4c51111
HealthLogTopicId no yes String Health check log topic ID of Cloud Log Service (CLS) for CLB
Example: c32fc818-e984-414a-b8f5-3985b4c52222
LocalBgp no yes Bool Whether the IP type is Local BGP
Example: false
MixIpTarget no yes Bool If the layer-7 listener of an IPv6FullChain CLB instance is enabled, the CLB instance can be bound with IPv4 and IPv6 CVM instances simultaneously.
Example: false
ClusterTag no yes String Layer-7 exclusive tag.
Example: FOR_L7
ClusterIds no yes Array of String Layer-7 exclusive cluster ID.
Example: ["cluster-xkd9xk30"]
VipIspAlias no yes String Alias of the ISP of the CLB IP address
Example: BGP

CertList

Tenant certificate list

Referenced by the following interfaces: DescribeCerts

name required NULL allowed type description
OwnerUin yes no String Owner
Example: 110000004918
ProjectId yes no String Project ID
Example: 0
From yes no String Certificate Source
Example: upload
CertType yes no String Product Type
Example: SVR
ProductZhName yes no String Product Name
Example: zhangsan@gmail.com
Domain yes no String Project domain name
Example: zhangsan@gmail.com
Alias yes no String Certificate remark or name
Example: zhangsan1
Status yes no Int64 Certificate Status
Example: 1
VulnerAbilityStatus yes no String Vulnerability status
Example: INACTIVE
CertBeginTime yes no String Start Time
Example: 2024-07-27 16:31:29
CertEndTime yes no String Expiration Time
Example: 2025-07-27 16:31:29
ValidityPeriod yes no String Policy validity period
Example: 12
InsertTime yes no String Storage time
Example: 2024-10-22 10:21:38
CertID yes no String Certificate ID
Example: Iz4eSk1n
StatusName yes no String Status name
Example: Approved
ProjectInfo yes no ProjectInfo Project Information
Example:View
Cert no no String Certificate Content
Example: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3WgAwIBAgIQA4ZHUAVO9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
SignCert no yes String Content of SM certificate signature
Example: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3W9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
SubjectAltName yes yes Array of String List of secondary domain names
Example: ["domain2.com"]
CertAlgorithm yes yes String Value type. Valid values: rsa, ecc, and sm2. Default: rsa
Example: rsa

Listener

Listener information

Referenced by the following interfaces: DescribeListeners

name required NULL allowed type description
ListenerId yes no String CLB listener ID
Example: lbl-odt45q4g
Protocol yes no String Listener protocol
Example: HTTP
ProtocolFake no no String Listener protocol (Fake).
Example: TCP
Port yes no Int64 Listener port
Example: 80
Certificate yes yes CertificateOutput Information of certificate bound to the listener
Example:View
HealthCheck yes yes HealthCheck Health check information of the listener
Example:View
Scheduler yes yes String Requested scheduling method
Example: WRR
SessionExpireTime yes yes Int64 Session persistence Duration
Example: 0
SniSwitch yes yes Int64 Whether to enable the SNI feature. (This parameter is applicable only to HTTPS listeners.)
Example: 0
Rules yes yes Array of RuleOutput All forwarding rules under a listener (This parameter is applicable only to HTTP/HTTPS Listeners.)
Example:View
ListenerName yes yes String Listener name
Example: Name
CreateTime yes yes String Listener creation time
Example: 2021-03-01 15:27:04
EndPort yes yes Int64 End port of a port range
Example: 0
TargetType yes yes String Real server type
Example: NODE
TargetGroup yes yes BasicTargetGroupInfo Basic information of a bound target group. This field will be returned if a target group is bound to a listener.
Example:View
DefaultSerSwitch yes yes Uint64 Whether the default domain identifier is enabled for the listener. 0: Not enabled; 1: Enabled
Example: 0
DeregisterTargetRst yes yes Bool Whether to send the RST packet to the client when a real server is unbound. This parameter is applicable only to TCP listeners.
Example: false
Toa yes yes Bool Supports Nat64 CLB TCP listeners only
Example: false
SessionType no yes String Session persistence type. NORMAL: Default session persistence type; QUIC_CID: Session persistence by Quic Connection ID.
Example: NORMAL
KeepaliveEnable no yes Int64 Whether to enable a persistent connection. 1: Enable; 0: Disable. (This parameter is applicable only to HTTP/HTTPS listeners.)
Example: 0

ExclusiveCluster

ExCluster

Referenced by the following interfaces: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, ModifyLoadBalancerAttributes

name required NULL allowed type description
L4Clusters no yes Array of ClusterItem Layer-4 exclusive cluster list
Example:View
L7Clusters no yes Array of ClusterItem Layer-7 exclusive cluster list
Example:View
ClassicalCluster no yes ClusterItem VPCGW cluster
Example:View

BindItem

Configuration binding relationship

Referenced by the following interfaces: AssociateCustomizedConfig

name required NULL allowed type description
LoadBalancerId yes no String ID of the CLB instance bound to the configuration
Example: lb-4d2yji93
ListenerId yes yes String ID of the listener bound to the configuration
Example: lbl-ds2yji93
Domain yes yes String Domain name bound to the configuration
Example: foo.net
LocationId no yes String Rule bound to the configuration
Example: loc-jdhsji93

OwnerLabel

User and tag correspondence

Referenced by the following interfaces: DescribeAppIdLabel

name required NULL allowed type description
Owner yes no Uint64 User AppId
Example: 127000001
Label yes no String Cluster Tag
Example: label1
SetType yes no String Cluster tag type. Valid values: L4_LAN_CLB, L4_WAN_CLB, L4_CLB, L7_LAN_CLB, L7_WAN_CLB, and L7_CLB
Example: L4_LAN_CLB

RuleInput

HTTP/HTTPS forwarding rule (input)

Referenced by the following interfaces: CreateRule

name required NULL allowed type description
Domain yes no String Domain name of the forwarding rule. Length limit: 1-80.
Example: www.realdomain.com
Url yes no String Path of the forwarding rule. Length limit: 1-200.
Example: /local
SessionExpireTime no no Int64 Session persistence time. 0: Disable session persistence. Value range: 30-3600. Unit: sec.
Example: 30
HealthCheck no no HealthCheck Health check information
Example:View
Certificate no no CertificateInput Certification information
Example:View
Scheduler no no String Request forwarding method of the rule. Valid values: WRR (weighted round robin), LEAST_CONN (least connections), and IP_HASH (IP hash)
Default: WRR
Example: WRR
ForwardType no no String Forwarding protocol between CLB and the real server. Valid values: HTTP, HTTPS, and TRPC
Example: HTTP
DefaultServer no no Bool Whether to set this domain name as the default domain name. Note: Only one default domain name can be set under a listener.
Example: true
Http2 no no Bool Whether to enable Http2. Note that Http2 can be enabled only for HTTPS domains.
Example: true
TargetType no no String Target real server type. NODE: Binding a general node; TARGETGROUP: Binding a target group.
Example: NODE
TrpcCallee no no String TRPC callee server route, which is required when ForwardType is TRPC
Example: trpcall
TrpcFunc no no String TRPC calling service API, which is required when ForwardType is TRPC
Example: trpcFunc

SnatIp

SnatIp information structure

Referenced by the following interfaces: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc

name required NULL allowed type description
SubnetId yes no String Unique VPC subnet ID. For example, subnet-j9x73ko1.
Example: 432
Ip no no String IP address, such as 192.168.0.1
Example: 1.1.1.1

ListenerBackend

Information of the real server bound to a listener

Referenced by the following interfaces: DescribeTargets

name required NULL allowed type description
ListenerId yes no String Listener ID
Example: lbl-di3kx902
Protocol yes no String Listener protocol
Example: TCP
Port yes no Int64 Listener port
Example: 80
Rules yes yes Array of RuleTargets Information of rules under a listener (applicable only to HTTP/HTTPS listeners)
Example:View
Targets yes yes Array of Backend List of real servers bound to the listener (applicable only to TCP/UDP/TCP_SSL listener)
Example:View
EndPort no yes Int64 End port in a port range if port range is supported, or 0 if port range is not supported
Example: 80

ClusterItem

Exclusive cluster information

Referenced by the following interfaces: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersForVpc, ModifyLoadBalancerAttributes

name required NULL allowed type description
ClusterId yes no String Unique ID of the cluster
Example: cluste-jd9x30xs
ClusterName no yes String Cluster Name
Example: cluster-1
Zone no yes String Cluster AZ. For example, ap-region1-1.
Example: ap-region1

CertificateInput

Certification information

Referenced by the following interfaces: CreateListener, CreateRule, ModifyDomainAttributes, ModifyListener

name required NULL allowed type description
SSLMode no no String Authentication type. UNIDIRECTIONAL: One-way authentication; MUTUAL: Mutual authentication
Example: MUTUAL
CertId no no String ID of the server RSA certificate. If this parameter is not specified, you must upload the certificate, including CertContent, CertKey, and CertName.
Example: j9sl3xs2
CertCaId no no String ID of the client CA certificate. When the listener adopts mutual authentication, that is, SSLMode=MUTUAL, this field is required if the client certificate is not uploaded, including CertCaContent, CertCaName.
Example: j9sl3xs2
CertName no no String Uploads the name of the server RSA certificate. This parameter is required if there is no CertId.
Example: cert-1
CertKey no no String Uploads the key of the server RSA certificate. This parameter is required if there is no CertId.
Example: -----BEGIN RSA PRIVATE KEY-----\r\nji93cs\r\n-----END RSA PRIVATE KEY-----\r\n
CertContent no no String Uploads the content of the server RSA certificate. This parameter is required if there is no CertId.
Example: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3W5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
CertCaName no no String Uploads the name of the client CA certificate. This parameter is required if SSLMode=mutual and there is no CertCaId.
Example: certca1
CertCaContent no no String Uploads the content of the client certificate. This parameter is required if SSLMode=mutual and there is no CertCaId.
Example: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3WgAwIBA9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
EccCertId no no String ID of the server ECC certificate. If this parameter is not specified, you must upload the certificate, including CertContent, CertKey, and CertName.
Example: xfdj3ghx
EccCertName no no String Uploads the name of the server ECC certificate. This parameter is required if there is no CertEccId.
Example: cert1
EccCertContent no no String Uploads the content of the server ECC certificate. This parameter is required if there is no CertEccId.
Example: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3WgAwqdNY9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
EccCertKey no no String Uploads the key of the server ECC certificate. This parameter is required if there is no CertEccId.
Example: -----BEGIN RSA PRIVATE KEY-----\r\nji93fd\r\n-----END RSA PRIVATE KEY-----\r\n
SmCertId no no String ID of the server SM certificate. If this parameter is not specified, you must upload the certificate, including CertSMContent, CertSmKey, CertSMName, CertSMSignContent, and CertSMSignKey.
Example: xfdj3ghx
SmCertName no no String Uploads the name of the server SM certificate. This parameter is required if there is no CertSMId.
Example: cert1
SmCertSignContent no no String Uploads the signature convention of the server SM certificate. This parameter is required if there is no CertSMId.
Example: -----BEGIN CERTIFICATE-----\r\nji93\r\n-----END CERTIFICATE-----\r\n
SmCertSignKey no no String Uploads the signature key of the server SM certificate. This parameter is required if there is no CertSMId.
Example: -----BEGIN RSA PRIVATE KEY-----\r\nji93df\r\n-----END RSA PRIVATE KEY-----\r\n
SmCertContent no no String Uploads the certificate convention of the server SM certificate. This parameter is required if there is no CertSMId.
Example: -----BEGIN CERTIFICATE-----\r\nji93\r\n-----END CERTIFICATE-----\r\n
SmCertKey no no String Uploads the certificate key of the server SM certificate. This parameter is required if there is no CertSMId.
Example: -----BEGIN RSA PRIVATE KEY-----\r\nji93fd\r\n-----END RSA PRIVATE KEY-----\r\n

CertListener

Attribute of the CLB listener bound to the certificate.

Referenced by the following interfaces: DescribeListenerListByCertId

name required NULL allowed type description
ListenerId no no String CLB listener ID
Example: lbl-jd8k32x3
ListenerName no no String Listener name
Example: Listener—Portal
LBId no no String CLB ID
Example: lb-jc8k3d0b
Protocol no no String Listener protocol
Example: TCP
Port no no Int64 Listener port
Example: 80
SSLMode no no String Authentication type. UNIDIRECTIONAL: One-way authentication; MUTUAL: Mutual authentication
Example: UNIDIRECTIONAL
CertId no no String Certificate ID.
Example: j9djk23x
CertCaId no no String Client certificate ID.
Example: j9djk23x
SniSwitch no no Int64 Whether to enable the SNI feature. (This parameter is applicable only to HTTPS listeners.)
Example: 0
AddTimestamp no no String Listener creation time
Example: 2024-02-21 12:00:00

FunctionTarget

Serverless Cloud Function (SCF) as a real server

Referenced by the following interfaces: DescribeTargetHealth, DescribeTargets

name required NULL allowed type description
Function no yes FunctionInfo SCF information
Example:View
Weight no yes Uint64 Weight
Example: 100

ProjectInfo

Certificate item

Referenced by the following interfaces: DescribeCerts

name required NULL allowed type description
ProjectId yes no String Project ID
Example: kdho2kx9
OwnerUin yes no String Project owner
Example: 110000004918
Name yes no String Project Name
Example: pj1
CreatorUin yes no String Creator
Example: 110000004918
CreateTime yes no String Creation Time
Example: 2014-08-03 12:00:00
Info yes no String Project Information
Example: info-1

BasicTargetGroupInfo

Basic information of a target group bound to a listener or forwarding rule

Referenced by the following interfaces: DescribeListeners, DescribeRewrite

name required NULL allowed type description
TargetGroupId yes no String Target group ID
Example: tg-di3kx902
TargetGroupName yes no String Target Group Name
Example: tg-1

ListenerHealth

Health check information of the listener

Referenced by the following interfaces: DescribeTargetHealth

name required NULL allowed type description
ListenerId yes no String Listener ID
Example: lbl-di3kx902
ListenerName yes yes String Listener name
Example: lbl-1
Protocol yes no String Listener protocol
Example: TCP
Port yes no Int64 Listener port
Example: 80
Rules yes yes Array of RuleHealth List of forwarding rules of the listener
Example:View

SubQuotaRsp

Description of results for sub-account quotas query

Referenced by the following interfaces: DescribeSubUinQuotas

name required NULL allowed type description
SubUin yes no String Sub-account UIN
Example: 110000004918
UsedQuota yes no Int64 Quota used by the sub-account
Example: 1
CurQuota yes no Int64 Current quota for the sub-account
Example: 4
LastSetTime yes no String Sub-account modification time
Example: 2014-08-03 12:00:00