Tenant Cloud Network Virtual Private Cloud High Availability Virtual IP APIs DescribeHaVips

DescribeHaVips

Last Updated At: 2026-08-02 00:06:18

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeHaVips) is used to query the list of high availability virtual IPs (HAVIPs).

Default interface request rate limit: 20 times per second.

Interface update time: 2025-08-15 19:35:15.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeHaVips
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
Offset No Yes Uint64 Offset. 0 by default.
Example: 0
Limit No Yes Uint64 Number of returns, 20 by default, up to 100.
Example: 20
Business No Yes String Product workload name. For example, TKE, SCF, or NFV.
Example: NFV
IpAddressType No Yes String Protocol type. Valid values: Ipv4 and Ipv6. Default value: Ipv4.
Example: Ipv4
HaVipIds No Yes Array of String Unique ID of HAVIP, e.g., havip-9o233uri.
Example: ["havip-bk4275i0","havip-2kce8v4q"]
Filters No Yes Array of Filter Filtering conditions. The parameters HaVipIds and Filters cannot be specified at the same time. 
  • havip-id - String - Unique ID of HAVIP. For example, havip-9o233uri.
  • havip-name - String - Name of HAVIP.
  • vpc-id - String - VPC ID of HAVIP.
  • subnet-id - String - Subnet ID of HAVIP.
  • vip - String - VIP address of HAVIP.
  • address-ip - String - Elastic IP address (EIP) bound to HAVIP.
  • havip-association.instance-id - String - Instance or ENI bound to HAVIP.
  • havip-association.instance-type - String - Type of the object bound to HAVIP. Valid values: CVM and ENI.
  • check-associate - Bool - Whether to verify the bound instance or ENI when HAVIP switch is enabled.
  • cdc-id - String - CDC instance ID.

    • Example:View

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible objects.
    Example: 1
    HaVipSet Array of HaVip HAVIP object array.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.Malformed Invalid input format.
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Range The parameter value is not within the specified range.
    InvalidParameterValue.TooLong Invalid input: Excessive length of the parameter.
    InvalidParameter.FilterInvalidKey
    InternalError.ModuleError