1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
本接口(CreateHaVip)用于创建高可用虚拟IP(HAVIP)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateHaVip。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
VpcId | 是 | String | HAVIP所在私有网络ID。 示例值:vpc-m0c2kcun |
SubnetId | 是 | String | HAVIP所在子网ID。 示例值:subnet-rtmfkg4w |
HaVipName | 是 | String | HAVIP名称。 示例值:demo |
Vip | 否 | String | 指定虚拟IP地址,必须在VPC网段内且未被占用。不指定则自动分配。 示例值:10.0.0.2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
HaVip | HaVip | HAVIP对象。 示例值:{"HaVipId":"havip-kekyk044","HaVipName":"demo","VpcId":"vpc-m0c2kcun","Vip":"10.0.0.2","SubnetId":"subnet-rtmfkg4w"} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建HAVIP
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHaVip
<公共请求参数>
{
"VpcId": "vpc-m0c2kcun",
"SubnetId": "subnet-rtmfkg4w",
"HaVipName": "irang_testHaVip"
}
输出示例
{
"Response": {
"HaVip": {
"AddressIp": "",
"CreatedTime": "2020-10-29 16:54:45",
"HaVipId": "havip-kekyk044",
"HaVipName": "demo",
"InstanceId": "",
"NetworkInterfaceId": "",
"State": "UNBIND",
"SubnetId": "subnet-rtmfkg4w",
"Vip": "172.16.0.17",
"VpcId": "vpc-m0c2kcun",
"Business": "TKE"
},
"RequestId": "d7226510-434e-4896-bdcd-fb1234aaafdfa"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InternalOperationFailure | 内部操作错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Duplicate | 重复数据。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.ObjectNotCurrentSubnet | 对象不在当前子网内。 |
InvalidParameterValue.TooLong | 参数值太长。 |
LimitExceeded | 超过配额限制。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |