1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateHaVip)用于创建高可用虚拟IP(HAVIP)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateHaVip。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | HAVIP 所在私有网络ID 。示例值:vpc-6v2ht8q5 |
HaVipName | 是 | String | HAVIP 名称。示例值:test+name |
SubnetId | 否 | String | HAVIP 所在子网ID 。示例值:subnet-qq51iwr4 |
Vip | 否 | String | 指定虚拟IP地址,必须在VPC 网段内且未被占用。不指定则自动分配。示例值:10.4.6.15 |
NetworkInterfaceId | 否 | String | HAVIP 所在弹性网卡ID 。示例值:eni-ph0075l1 |
CheckAssociate | 否 | Boolean | 是否开启HAVIP 漂移时子机或网卡范围的校验。默认不开启。示例值:True |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
HaVip | HaVip | HAVIP 对象。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建HAVIP
创建HAVIP
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHaVip
<公共请求参数>
{
"SubnetId": "subnet-qq51iwr4",
"Vip": "10.4.6.15",
"VpcId": "vpc-6v2ht8q5",
"HaVipName": "test+name"
}
输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Duplicate | 入参重复。 |
InvalidParameterValue.InvalidBusiness | 参数的值不存在或不支持。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.Reserved | 参数值是一个系统保留对象。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation.SubnetNotExists | 子网不存在。 |