DescribeHaVips

Last updated: 2020-04-10 10:00:16

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (DescribeHaVips) is used to query the list of highly available virtual IPs (HAVIP).

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeHaVips.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
HaVipIds.N No Array of String The unique ID of the HAVIP, such as havip-9o233uri.
Filters.N No Array of Filter Filter condition. HaVipIds and Filters cannot be specified at the same time.
  • havip-id - String - The unique ID of the HAVIP, such as havip-9o233uri.
  • havip-name - String - HAVIP name.
  • vpc-id - String - The ID of the VPC where HAVIP is located.
  • subnet-id - String - The ID of the subnet where HAVIP is located.
  • address-ip - String - The EIP to which HAVIP is bound.
  • Offset No Integer Offset
    Limit No Integer The returned quantity

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of objects meeting the condition.
    HaVipSet Array of HaVip HAVIP object array.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the HAVIP list by multiple conditions

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeHaVips
    &Filters.0.Name=havip-name
    &Filters.0.Values.0=test
    &Filters.1.Name=vpc-id
    &Filters.1.Values.0=vpc-6v2ht8q5
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "HaVipSet": [
          {
            "HaVipId": "havip-iyy1ykky",
            "HaVipName": "test modify",
            "Vip": "10.4.6.17",
            "VpcId": "vpc-6v2ht8q5",
            "SubnetId": "subnet-qq51iwr4",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "Business": "",
            "State": "UNBOUND",
            "CreatedTime": "2018-10-09 18:08:16"
          }
        ],
        "TotalCount": 1,
        "RequestId": "659cd6a3-a75a-473c-8280-af27c33da8bd"
      }
    }

    Example2 Querying the HAVIP list by ID

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeHaVips
    &HaVipIds.0=havip-bk4275i0
    &HaVipIds.1=havip-2kce8v4q
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "HaVipSet": [
          {
            "HaVipId": "havip-2kce8v4q",
            "HaVipName": "tadfafd",
            "Vip": "10.3.3.15",
            "VpcId": "vpc-o31qeah3",
            "SubnetId": "subnet-8qywqc4y",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "Business": "",
            "State": "UNBOUND",
            "CreatedTime": "2018-04-03 20:00:05"
          },
          {
            "HaVipId": "havip-bk4275i0",
            "HaVipName": "22",
            "Vip": "10.2.0.14",
            "VpcId": "vpc-2mcdauzl",
            "SubnetId": "subnet-mnmm19fg",
            "NetworkInterfaceId": "",
            "InstanceId": "",
            "AddressIp": "",
            "Business": "",
            "State": "UNBOUND",
            "CreatedTime": "2018-04-03 20:05:33"
          }
        ],
        "TotalCount": 2,
        "RequestId": "1c827bf1-837f-4302-b51a-4d538b7ad249"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameterValue.Malformed Invalid input parameter format.