CreateHaVip

Last updated: 2021-05-24 16:20:18

1. API Description

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

This API (CreateHaVip) is used to create a highly available virtual IP (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

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 parameter. The value used for this API: CreateHaVip.
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.
VpcId	Yes	String	The `ID` of the VPC to which the `HAVIP` belongs.
SubnetId	Yes	String	The `ID` of the subnet to which the `HAVIP` belongs.
HaVipName	Yes	String	The name of the `HAVIP`.
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 a HAVIP

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateHaVip
&VpcId=vpc-6v2ht8q5
&SubnetId=subnet-qq51iwr4
&HaVipName=test+name
&Vip=10.4.6.15
&<Common request parameters>

Output Example

{
  "Response": {
    "HaVip": {
      "HaVipId": "havip-72alakye",
      "HaVipName": "test name",
      "Vip": "10.4.6.15",
      "VpcId": "vpc-6v2ht8q5",
      "SubnetId": "subnet-qq51iwr4",
      "NetworkInterfaceId": "",
      "InstanceId": "",
      "AddressIp": "",
      "State": "UNBIND",
      "CreatedTime": "2018-10-10 17:03:09",
      "Business": "SCF"
    },
    "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
  }
}

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

Tencent Cloud CLI 3.0

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	A parameter error occurred.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.Duplicate	The input parameter already exists.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.TooLong	Invalid parameter value. The parameter value is too long.
LimitExceeded	Quota limit is reached.
ResourceInsufficient	Insufficient resources.
ResourceNotFound	The resource does not exist.

Recent Pages

CreateHaVip

1. API Description

2. Input Parameters

3. Output Parameters