tencent cloud

Feedback

DescribeHaVips

Last updated: 2022-03-31 16:51:23

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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.
li>havip-id - String - The unique ID of the HAVIP, such as havip-9o233uri.
  • havip-name - String - HAVIP name.
  • vpc-id - String - VPC ID of the HAVIP.
  • subnet-id - String - Subnet ID of the HAVIP.
  • vip - String - Virtual IP address of the HAVIP.
  • address-ip - String - Bound EIP.
  • 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 details by IDs

    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"
      }
    }
    

    Example2 Querying the HAVIP details 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"
      }
    }
    

    5. Developer Resources

    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.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support