tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Gateway Load Balancer
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-11-25 10:16:32
    Download PDF

    AssociationItem

    Rule associated with target group

    Used by actions: DescribeTargetGroupList, DescribeTargetGroups.

    Name Type Description
    LoadBalancerId String Associated GWLB instance ID
    LoadBalancerName String GWLB instance name

    Filter

    Filter criteria

    Used by actions: DescribeGatewayLoadBalancers, DescribeTargetGroupInstances, DescribeTargetGroupList, DescribeTargetGroups.

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

    GatewayLoadBalancer

    Information on the GWLB instance

    Used by actions: DescribeGatewayLoadBalancers.

    Name Type Description
    LoadBalancerId String GWLB instance ID.
    LoadBalancerName String Name of the GWLB instance.
    VpcId String VPC to which the GWLB belongs.Note: this field may return null, indicating that no valid values can be obtained.
    SubnetId String Subnet to which the GWLB belongs.
    Vips Array of String Virtual IP of GWLB for providing service.
    Status Integer GWLB instance status.0: creating, 1: normal operation, 3: deleting.
    TargetGroupId String Unique ID of associated target group.Note: this field may return null, indicating that no valid values can be obtained.
    DeleteProtect Boolean Whether to enable the deletion protection feature.Note: this field may return null, indicating that no valid values can be obtained.
    Tags Array of TagInfo Tag information on the CLB instance.Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time.
    ChargeType String Billing type of the GWLB instance. POSTPAID_BY_HOUR: pay-as-you-goNote: this field may return null, indicating that no valid values can be obtained.
    Isolation Integer 0: Not isolated; 1: Isolated.

    Note: this field may return null, indicating that no valid values can be obtained.
    IsolatedTime String CLB instance isolation time

    Note: this field may return null, indicating that no valid values can be obtained.

    ItemPrice

    It describes the price information of a single item.

    Used by actions: InquirePriceCreateGatewayLoadBalancer.

    Name Type Description
    UnitPrice Float Postpaid unit price. Unit: CNY.

    Note: This field may return null, indicating that no valid value can be obtained.
    ChargeUnit String Pay-as-you-go billing unit. Valid values: HOUR: indicates that the billing unit is calculated by hour. Current scenarios involving this billing unit include: postpaid by hour for instances (POSTPAID_BY_HOUR).Note: This field may return null, indicating that no valid value can be obtained.
    OriginalPrice Float Original price of pre-payment (in CNY).

    Note: This field may return null, indicating that no valid value can be obtained.
    DiscountPrice Float Discount price of prepaid costs, unit: CNY.

    Note: This field may return null, indicating that no valid value can be obtained.
    UnitPriceDiscount Float Discounted unit price for pay-as-you-go. Unit: CNY.Note: This field may return null, indicating that no valid value can be obtained.
    Discount Float Discount, such as 20.0 representing 80% off.

    Note: This field may return null, indicating that no valid value can be obtained.

    Price

    It indicates the price of the GWLB.

    Used by actions: InquirePriceCreateGatewayLoadBalancer.

    Name Type Description
    InstancePrice ItemPrice It describes the instance price.Note: This field may return null, indicating that no valid value can be obtained.
    LcuPrice ItemPrice It describes the price of GLCU.
    Note: This field may return null, indicating that no valid value can be obtained.

    TagInfo

    Tag information on GWLB

    Used by actions: CreateGatewayLoadBalancer, DescribeGatewayLoadBalancers.

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

    TargetGroupAssociation

    Association relationship between rules and target groups.

    Used by actions: AssociateTargetGroups, DisassociateTargetGroups.

    Name Type Required Description
    LoadBalancerId String Yes GWLB instance ID.
    TargetGroupId String Yes Target group ID.

    TargetGroupBackend

    Real server bound to a target group

    Used by actions: DescribeTargetGroupInstances.

    Name Type Description
    TargetGroupId String Target group ID
    Type String Backend service type. Valid values: CVM, ENI (to be supported soon)
    InstanceId String Unique backend service ID
    Port Integer Listening port of backend service
    Weight Integer Forwarding weight of backend service. Value range: [0, 100]. Default value: 10.
    PublicIpAddresses Array of String Public network IP of the real server

    Note: This field may return null, indicating that no valid value can be obtained.
    PrivateIpAddresses Array of String Private network IP of backend serviceNote: This field may return null, indicating that no valid value can be obtained.
    InstanceName String Instance name of the real server

    Note: This field may return null, indicating that no valid value can be obtained.
    RegisteredTime Timestamp ISO8601 Real server binding time

    Note: This field may return null, indicating that no valid value can be obtained.
    EniId String Unique ID of the ENI

    Note: This field may return null, indicating that no valid value can be obtained.
    ZoneId Integer Available zone ID of backend serviceNote: This field may return null, indicating that no valid value can be obtained.

    TargetGroupHealthCheck

    Details of target group health check

    Used by actions: CreateTargetGroup, DescribeTargetGroupList, DescribeTargetGroups, ModifyTargetGroupAttribute.

    Name Type Required Description
    HealthSwitch Boolean Yes Whether to enable the health check.
    Protocol String No Protocol used for health check, which supports PING and TCP and is PING by default.

    - PING: icmp
    - TCP: tcp
    Port Integer No Health check port, which is required when the probe protocol is TCP.
    Timeout Integer No Health check timeout. The default is 2 seconds. Value range: 2-30 seconds.
    IntervalTime Integer No Detection interval time. The default is 5 seconds. Value range: 2-300 seconds.
    HealthNum Integer No Health detection threshold. The default is 3 times. Value range: 2-10 times.
    UnHealthNum Integer No Unhealth detection threshold. The default is 3 times. Value range: 2-10 times.

    TargetGroupInfo

    Target group information

    Used by actions: DescribeTargetGroupList, DescribeTargetGroups.

    Name Type Description
    TargetGroupId String Target group ID
    VpcId String VPCID of target group
    TargetGroupName String Target group name
    Port Integer Default port of a target group

    Note: This field may return null, indicating that no valid value can be obtained.
    CreatedTime Timestamp ISO8601 Target group creation time
    UpdatedTime Timestamp ISO8601 Target group modification time
    AssociatedRule Array of AssociationItem Associated rule array. This parameter cannot be obtained when the DescribeTargetGroupList API is called.Note: This field may return null, indicating that no valid value can be obtained.
    Protocol String Backend protocol type.Note: This field may return null, indicating that no valid value can be obtained.
    ScheduleAlgorithm String Scheduling algorithm.
    ip_hash_3: elastic hashing
    Note: This field may return null, indicating that no valid value can be obtained.
    HealthCheck TargetGroupHealthCheck Health check details.Note: This field may return null, indicating that no valid value can be obtained.
    AllDeadToAlive Boolean Whether "All Dead, All Alive" is supported.Note: This field may return null, indicating that no valid value can be obtained.
    AssociatedRuleCount Integer Number of rules associated with the target group.Note: This field may return null, indicating that no valid value can be obtained.
    RegisteredInstancesCount Integer Number of instances in the target group.Note: This field may return null, indicating that no valid value can be obtained.

    TargetGroupInstance

    Target group instance

    Used by actions: CreateTargetGroup, DeregisterTargetGroupInstances, ModifyTargetGroupInstancesWeight, RegisterTargetGroupInstances.

    Name Type Required Description
    BindIP String Yes Private network IP of target group instance.
    Port Integer No Port of target group instance. Only 6081 is supported.
    Weight Integer No Weight of target group instance. Only 0 or 16 is supported, and non-0 is uniformly treated as 16.

    TargetGroupInstanceStatus

    It is used for the health check status of the target group backend RS.

    Used by actions: DescribeTargetGroupInstanceStatus.

    Name Type Description
    InstanceIp String IP of backend RS
    Status String Health check status, with parameter values and meanings as follows:● on: indicates being under detection.● off: indicates that the health check is disabled.● health: indicates being healthy.● unhealth: indicates being abnormal.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy