tencent cloud



Last updated: 2023-08-18 14:28:12

1. API Description

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

This API is used to create an 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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateHaVip.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
VpcId Yes String VPC ID of the HAVIP.
SubnetId Yes String Subnet ID of the HAVIP.
HaVipName Yes String HAVIP name.
Vip No String The specified virtual IP address, which must be within the IP range of the VPC and not in use. It will be automatically assigned if not specified.

3. Output Parameters

Parameter Name Type Description
HaVip HaVip HAVIP object.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating HAVIP

Input Example

Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHaVip
<Common request parameters>

    "VpcId": "vpc-m0c2kcun",
    "SubnetId": "subnet-rtmfkg4w",
    "HaVipName": "irang_testHaVip"

Output Example

    "Response": {
        "HaVip": {
            "AddressIp": "",
            "CreatedTime": "2020-10-29 16:54:45",
            "HaVipId": "havip-kekyk044",
            "HaVipName": "irang_testHaVip",
            "InstanceId": "",
            "NetworkInterfaceId": "",
            "State": "UNBIND",
            "SubnetId": "subnet-rtmfkg4w",
            "Vip": "",
            "VpcId": "vpc-m0c2kcun",
            "Business": "xx"
        "RequestId": "d7226510-434e-4896-bdcd-fb1234aaafdfa"

5. Developer Resources


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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.Duplicate The data is duplicate.
InvalidParameterValue.Malformed The input parameter format is invalid.
InvalidParameterValue.ObjectNotCurrentSubnet The object is not in the current subnet.
InvalidParameterValue.TooLong The parameter value is too long.
LimitExceeded The quota limit is exceeded.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
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