public class CreateLoadBalancerRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
CreateLoadBalancerRequest() |
CreateLoadBalancerRequest(CreateLoadBalancerRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String |
getAccessLogTopicId()
Get Topic ID of logs of traffic access over layer-7 protocols.
|
String |
getAddressIPVersion()
Get It's only applicable to public network CLB instances.
|
String |
getBandwidthPackageId()
Get Bandwidth package ID.
|
String |
getClientToken()
Get A unique string supplied by the client to ensure that the request is idempotent.
|
String[] |
getClusterIds()
Get Cluster ID.
|
String |
getClusterTag()
Get Tag for the STGW exclusive cluster.
|
Boolean |
getDynamicVip()
Get Upgrades to domain name-based CLB
|
String |
getEgress()
Get Network egress point
|
String |
getEipAddressId()
Get Unique ID of an EIP, which can only be used when binding the EIP of a private network CLB instance.
|
ExclusiveCluster |
getExclusiveCluster()
Get Information about the dedicated CLB instance.
|
Long |
getForward()
Get CLB instance type.
|
InternetAccessible |
getInternetAccessible()
Get Network billing mode by the maximum outbound bandwidth.
|
LBChargePrepaid |
getLBChargePrepaid()
Get Prepayment-related attributes of a CLB instance.
|
String |
getLBChargeType()
Get Billing type of a CLB instance.
|
String |
getLoadBalancerName()
Get CLB instance name, which takes effect only when only one instance is to be created in the request.
|
Boolean |
getLoadBalancerPassToTarget()
Get Whether to allow CLB traffic to the target group.
|
String |
getLoadBalancerType()
Get CLB instance network type:
OPEN: public network; INTERNAL: private network.
|
String |
getMasterZoneId()
Get Applicable only to public network IPv4 CLB instances.
|
Long |
getNumber()
Get Number of CLBs to be created.
|
Long |
getProjectId()
Get ID of the project to which a CLB instance belongs, which can be obtained through the `DescribeProject` API.
|
String |
getSlaType()
Get Specification of the LCU-supported instance.If you need to create an LCU-supported instance, this parameter is required.
|
String |
getSlaveZoneId()
Get Applicable only to public network IPv4 CLB instances.
|
SnatIp[] |
getSnatIps()
Get Creates `SnatIp` when the binding IPs of other VPCs feature is enabled
|
Boolean |
getSnatPro()
Get Whether Binding IPs of other VPCs feature switch
|
String |
getSubnetId()
Get A subnet ID should be specified when you purchase a private network CLB instance under a VPC.
|
TagInfo[] |
getTags()
Get Tags the CLB instance when purchasing it.
|
String |
getVip()
Get Specifies the VIP for the application of a CLB instance.
|
String |
getVipIsp()
Get ISP of VIP.
|
String |
getVpcId()
Get Network ID of the target device on the CLB backend, such as `vpc-12345678`, which can be obtained through the `DescribeVpcEx` API.
|
String |
getZoneId()
Get Applicable only to public network IPv4 CLB instances.
|
void |
setAccessLogTopicId(String AccessLogTopicId)
Set Topic ID of logs of traffic access over layer-7 protocols.
|
void |
setAddressIPVersion(String AddressIPVersion)
Set It's only applicable to public network CLB instances.
|
void |
setBandwidthPackageId(String BandwidthPackageId)
Set Bandwidth package ID.
|
void |
setClientToken(String ClientToken)
Set A unique string supplied by the client to ensure that the request is idempotent.
|
void |
setClusterIds(String[] ClusterIds)
Set Cluster ID.
|
void |
setClusterTag(String ClusterTag)
Set Tag for the STGW exclusive cluster.
|
void |
setDynamicVip(Boolean DynamicVip)
Set Upgrades to domain name-based CLB
|
void |
setEgress(String Egress)
Set Network egress point
|
void |
setEipAddressId(String EipAddressId)
Set Unique ID of an EIP, which can only be used when binding the EIP of a private network CLB instance.
|
void |
setExclusiveCluster(ExclusiveCluster ExclusiveCluster)
Set Information about the dedicated CLB instance.
|
void |
setForward(Long Forward)
Set CLB instance type.
|
void |
setInternetAccessible(InternetAccessible InternetAccessible)
Set Network billing mode by the maximum outbound bandwidth.
|
void |
setLBChargePrepaid(LBChargePrepaid LBChargePrepaid)
Set Prepayment-related attributes of a CLB instance.
|
void |
setLBChargeType(String LBChargeType)
Set Billing type of a CLB instance.
|
void |
setLoadBalancerName(String LoadBalancerName)
Set CLB instance name, which takes effect only when only one instance is to be created in the request.
|
void |
setLoadBalancerPassToTarget(Boolean LoadBalancerPassToTarget)
Set Whether to allow CLB traffic to the target group.
|
void |
setLoadBalancerType(String LoadBalancerType)
Set CLB instance network type:
OPEN: public network; INTERNAL: private network.
|
void |
setMasterZoneId(String MasterZoneId)
Set Applicable only to public network IPv4 CLB instances.
|
void |
setNumber(Long Number)
Set Number of CLBs to be created.
|
void |
setProjectId(Long ProjectId)
Set ID of the project to which a CLB instance belongs, which can be obtained through the `DescribeProject` API.
|
void |
setSlaType(String SlaType)
Set Specification of the LCU-supported instance.If you need to create an LCU-supported instance, this parameter is required.
|
void |
setSlaveZoneId(String SlaveZoneId)
Set Applicable only to public network IPv4 CLB instances.
|
void |
setSnatIps(SnatIp[] SnatIps)
Set Creates `SnatIp` when the binding IPs of other VPCs feature is enabled
|
void |
setSnatPro(Boolean SnatPro)
Set Whether Binding IPs of other VPCs feature switch
|
void |
setSubnetId(String SubnetId)
Set A subnet ID should be specified when you purchase a private network CLB instance under a VPC.
|
void |
setTags(TagInfo[] Tags)
Set Tags the CLB instance when purchasing it.
|
void |
setVip(String Vip)
Set Specifies the VIP for the application of a CLB instance.
|
void |
setVipIsp(String VipIsp)
Set ISP of VIP.
|
void |
setVpcId(String VpcId)
Set Network ID of the target device on the CLB backend, such as `vpc-12345678`, which can be obtained through the `DescribeVpcEx` API.
|
void |
setZoneId(String ZoneId)
Set Applicable only to public network IPv4 CLB instances.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public CreateLoadBalancerRequest()
public CreateLoadBalancerRequest(CreateLoadBalancerRequest source)
public String getLoadBalancerType()
public void setLoadBalancerType(String LoadBalancerType)
LoadBalancerType
- CLB instance network type:
OPEN: public network; INTERNAL: private network.public Long getForward()
public void setForward(Long Forward)
Forward
- CLB instance type. Valid value: 1 (generic CLB instance).public String getLoadBalancerName()
public void setLoadBalancerName(String LoadBalancerName)
LoadBalancerName
- CLB instance name, which takes effect only when only one instance is to be created in the request. It can consist 1 to 60 letters, digits, hyphens (-), or underscores (_).
Note: if the name of the new CLB instance already exists, a default name will be generated automatically.public String getVpcId()
public void setVpcId(String VpcId)
VpcId
- Network ID of the target device on the CLB backend, such as `vpc-12345678`, which can be obtained through the `DescribeVpcEx` API. If this parameter is not entered, `DefaultVPC` is used by default. This parameter is required when creating a private network instance.public String getSubnetId()
public void setSubnetId(String SubnetId)
SubnetId
- A subnet ID should be specified when you purchase a private network CLB instance under a VPC. The VIP of the private network CLB instance is in this subnet. This parameter is required when you create a private network CLB instance but not supported when you create a public network IPv4 CLB instance.public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- ID of the project to which a CLB instance belongs, which can be obtained through the `DescribeProject` API. If this parameter is not entered, the default project will be used.public String getAddressIPVersion()
public void setAddressIPVersion(String AddressIPVersion)
AddressIPVersion
- It's only applicable to public network CLB instances. IP version. Values: `IPV4`, `IPV6` and `IPv6FullChain` (case-insensitive). Default: `IPV4`. Note: `IPV6` indicates IPv6 NAT64, while `IPv6FullChain` indicates IPv6.public Long getNumber()
public void setNumber(Long Number)
Number
- Number of CLBs to be created. Default value: 1.public String getMasterZoneId()
public void setMasterZoneId(String MasterZoneId)
MasterZoneId
- Applicable only to public network IPv4 CLB instances. This parameter specifies the primary AZ ID for cross-AZ disaster recovery. For example, 100001 or ap-guangzhou-1.
Note: The primary AZ sustains traffic. The secondary AZ does not sustain traffic by default and is used only when the primary AZ is unavailable. Currently, primary and secondary AZs are supported only for IPv4 CLB instances in Guangzhou, Shanghai, Nanjing, Beijing, Chengdu, Shenzhen Finance, Hong Kong (China), Seoul, Frankfurt, and Singapore regions. You can call the [DescribeResources](https://intl.cloud.tencent.com/document/api/214/70213?from_cn_redirect=1) API to query the list of primary AZs in a region. If you want to experience this feature, [submit a ticket](https://console.cloud.tencent.com/workorder/category).public String getZoneId()
public void setZoneId(String ZoneId)
ZoneId
- Applicable only to public network IPv4 CLB instances. This parameter specifies the AZ ID for creating a CLB instance. For example, ap-guangzhou-1.public InternetAccessible getInternetAccessible()
public void setInternetAccessible(InternetAccessible InternetAccessible)
InternetAccessible
- Network billing mode by the maximum outbound bandwidth. It applies only to private network LCU-supported instances and all public network instances. The feature of purchasing monthly subscription instances via an API is under grayscale release. If you want to experience this feature, [submit a ticket](https://console.cloud.tencent.com/workorder/category).public String getVipIsp()
public void setVipIsp(String VipIsp)
VipIsp
- ISP of VIP. Values: `CMCC` (China Mobile), `CUCC` (China Unicom) and `CTCC` (China Telecom). You need to activate static single-line IPs. This feature is in beta and is only available in Guangzhou, Shanghai, Nanjing, Jinan, Hangzhou, Fuzhou, Beijing, Shijiazhuang, Wuhan, Changsha, Chengdu and Chongqing regions. To try it out, please contact your sales rep. If it's specified, the network billing mode must be `BANDWIDTH_PACKAGE`. If it's not specified, BGP is used by default. To query ISPs supported in a region, please use [DescribeResources](https://intl.cloud.tencent.com/document/api/214/70213?from_cn_redirect=1).public TagInfo[] getTags()
public void setTags(TagInfo[] Tags)
Tags
- Tags the CLB instance when purchasing it. Up to 20 tag key value pairs are supported.public String getVip()
public void setVip(String Vip)
Vip
- Specifies the VIP for the application of a CLB instance. This parameter is optional. If you do not specify this parameter, the system automatically assigns a value for the parameter. IPv4 and IPv6 CLB instances support this parameter, but IPv6 NAT64 CLB instances do not.
Note: If the specified VIP is occupied or is not within the IP range of the specified VPC subnet, you cannot use the VIP to create a CLB instance in a private network or an IPv6 BGP CLB instance in a public network.public String getBandwidthPackageId()
public void setBandwidthPackageId(String BandwidthPackageId)
BandwidthPackageId
- Bandwidth package ID. If this parameter is specified, the network billing mode (InternetAccessible.InternetChargeType) will only support billing by bandwidth package (BANDWIDTH_PACKAGE). The attributes of the bandwidth package determine the settlement method. For IPv6 CLB instances purchased by bill-by-CVM users, if the ISP type is not BGP, the bandwidth package ID cannot be specified.public ExclusiveCluster getExclusiveCluster()
public void setExclusiveCluster(ExclusiveCluster ExclusiveCluster)
ExclusiveCluster
- Information about the dedicated CLB instance. You must specify this parameter when you create a dedicated CLB instance in a private network.public String getSlaType()
public void setSlaType(String SlaType)
SlaType
- Specification of the LCU-supported instance.public String[] getClusterIds()
public void setClusterIds(String[] ClusterIds)
ClusterIds
- Cluster ID. This cluster identifier is used for configuring a public cloud exclusive cluster or a cloud dedicated cluster. To apply for a public cloud exclusive cluster, [submit a ticket](https://console.cloud.tencent.com/workorder/category). For cloud dedicated clusters, see the descriptions in [Cloud Dedicated Cluster](https://intl.cloud.tencent.com/document/product/1346?from_cn_redirect=1).public String getClientToken()
public void setClientToken(String ClientToken)
ClientToken
- A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.public Boolean getSnatPro()
public void setSnatPro(Boolean SnatPro)
SnatPro
- Whether Binding IPs of other VPCs feature switchpublic SnatIp[] getSnatIps()
public void setSnatIps(SnatIp[] SnatIps)
SnatIps
- Creates `SnatIp` when the binding IPs of other VPCs feature is enabledpublic String getClusterTag()
public void setClusterTag(String ClusterTag)
ClusterTag
- Tag for the STGW exclusive cluster.public String getSlaveZoneId()
public void setSlaveZoneId(String SlaveZoneId)
SlaveZoneId
- Applicable only to public network IPv4 CLB instances. This parameter specifies the secondary AZ ID for cross-AZ disaster recovery. For example, 100001 or ap-guangzhou-1.
Note: The secondary AZ sustains traffic when the primary AZ encounters faults. You can call the [DescribeResources](https://intl.cloud.tencent.com/document/api/214/70213?from_cn_redirect=1) API to query the list of primary/secondary AZs in a region. If you want to experience this feature, [submit a ticket](https://console.cloud.tencent.com/workorder/category).public String getEipAddressId()
public void setEipAddressId(String EipAddressId)
EipAddressId
- Unique ID of an EIP, which can only be used when binding the EIP of a private network CLB instance. E.g., `eip-11112222`.public Boolean getLoadBalancerPassToTarget()
public void setLoadBalancerPassToTarget(Boolean LoadBalancerPassToTarget)
LoadBalancerPassToTarget
- Whether to allow CLB traffic to the target group. `true`: allows CLB traffic to the target group and verifies security groups only on CLB; `false`: denies CLB traffic to the target group and verifies security groups on both CLB and backend instances.public Boolean getDynamicVip()
public void setDynamicVip(Boolean DynamicVip)
DynamicVip
- Upgrades to domain name-based CLBpublic String getEgress()
public void setEgress(String Egress)
Egress
- Network egress pointpublic LBChargePrepaid getLBChargePrepaid()
public void setLBChargePrepaid(LBChargePrepaid LBChargePrepaid)
LBChargePrepaid
- Prepayment-related attributes of a CLB instance. The feature of purchasing monthly subscription instances via an API is under grayscale release. If you want to experience this feature, [submit a ticket](https://console.cloud.tencent.com/workorder/category).public String getLBChargeType()
public void setLBChargeType(String LBChargeType)
LBChargeType
- Billing type of a CLB instance. Valid values: POSTPAID_BY_HOUR and PREPAID. Default value: POSTPAID_BY_HOUR. The feature of purchasing monthly subscription instances via an API is under grayscale release. If you want to experience this feature, [submit a ticket](https://console.cloud.tencent.com/workorder/category).public String getAccessLogTopicId()
public void setAccessLogTopicId(String AccessLogTopicId)
AccessLogTopicId
- Topic ID of logs of traffic access over layer-7 protocols.Copyright © 2025. All rights reserved.