1. 接口描述
接口请求域名： antiddos.tencentcloudapi.com 。
通过API 购买高防包接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBgpInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-09。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| InstanceChargeType | 是 | String | 付费类型：付费模式：PREPAID 预付费 POSTPAID_BY_MONTH 后付费 示例值：PREPAID |
| PackageType | 是 | String | 高防包类型：高防包类型，Enterprise(企业版) Standard(标准版) StandardPlus(标准版2.0) 示例值：Standard |
| InstanceCount | 是 | Integer | 购买高防包的数量，一次购买数量不超过10 示例值：1 |
| InstanceChargePrepaid | 否 | InstanceChargePrepaid | { "Period": 3, "RenewFlag": "NOTIFY_AND_AUTO_RENEW" } |
| EnterprisePackageConfig | 否 | EnterprisePackageConfig | { "Region": "ap-guangzhou", "ProtectIpCount": 1, "BasicProtectBandwidth": 300, "Bandwidth": 100, "ElasticProtectLimit": 0, "ElasticBandwidthFlag": true } |
| StandardPackageConfig | 否 | StandardPackageConfig | { "Region": "ap-guangzhou", "ProtectIpCount": 1, "BasicProtectBandwidth": 300, "Bandwidth": 100, "ElasticProtectLimit": 0, "ElasticBandwidthFlag": true } |
| StandardPlusPackageConfig | 否 | StandardPlusPackageConfig | { "Region": "ap-guangzhou", "ProtectCount": "TWO_TIMES", "ProtectIpCount": 1, "Bandwidth": 100, "ElasticBandwidthFlag": true } |
| TagInfoList.N | 否 | Array of TagInfo | [ { "TagKey": "beal-test", "TagValue": "beal-test" } ] |
| DryRun | 否 | Boolean | 默认为false,true表示只进行参数校验，不进行实际购买 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceIds | Array of String | bgpIds 示例值：["bgp-0000043i"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 预付费标准版2.0-2次防护-1IP-业务带宽10Mbps
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBgpInstance
<公共请求参数>
{
"InstanceChargeType": "PREPAID",
"PackageType": "StandardPlus",
"InstanceCount": 1,
"InstanceChargePrepaid": {
"Period": 3,
"RenewFlag": "NOTIFY_AND_AUTO_RENEW"
},
"StandardPlusPackageConfig": {
"Region": "ap-guangzhou",
"ProtectCount": "TWO_TIMES",
"ProtectIpCount": 1,
"Bandwidth": 10,
"ElasticBandwidthFlag": true
},
"TagInfoList": [],
"DryRun": false
}输出示例
{
"Response": {
"ResourceIds": [
"bgp-00000451"
],
"RequestId": "fe8e9c34-a2c0-4bb2-a874-2b7386adbd97"
}
}示例2 预付费模式-广州地域-标准版购买10M-1IP
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBgpInstance
<公共请求参数>
{
"InstanceChargeType": "PREPAID",
"PackageType": "Standard",
"InstanceCount": 1,
"InstanceChargePrepaid": {
"Period": 3,
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
},
"StandardPackageConfig": {
"Region": "ap-guangzhou",
"ProtectIpCount": 1,
"Bandwidth": 10,
"ElasticBandwidthFlag": true
},
"TagInfoList": [],
"DryRun": false
}输出示例
{
"Response": {
"ResourceIds": [
"bgp-0000043i"
],
"RequestId": "e122a577-1266-4193-b223-f8cb654b5209"
}
}示例3 预付费模式-购买企业版高防包-保底带宽300Gbps业务带宽10Mbps防护IP数1
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBgpInstance
<公共请求参数>
{
"InstanceChargeType": "PREPAID",
"PackageType": "Enterprise",
"InstanceCount": 1,
"InstanceChargePrepaid": {
"Period": 3,
"RenewFlag": "NOTIFY_AND_AUTO_RENEW"
},
"EnterprisePackageConfig": {
"Region": "ap-guangzhou",
"ProtectIpCount": 1,
"BasicProtectBandwidth": 300,
"Bandwidth": 10,
"ElasticBandwidthFlag": true
},
"TagInfoList": [
{
"TagKey": "beal-test",
"TagValue": "beal-test"
}
],
"DryRun": false
}输出示例
{
"Response": {
"ResourceIds": [
"bgp-00000450"
],
"RequestId": "dc81b4ff-730a-4907-a2eb-b08fc1e1e8b8"
}
}示例4 后付费标准版防护IP10 业务带宽100Mbps
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBgpInstance
<公共请求参数>
{
"InstanceChargeType": "POSTPAID_BY_MONTH",
"PackageType": "Standard",
"InstanceCount": 1,
"StandardPackageConfig": {
"Region": "ap-shanghai",
"ProtectIpCount": 10,
"Bandwidth": 100
},
"DryRun": false
}输出示例
{
"Response": {
"ResourceIds": [
"bgp-000004ku"
],
"RequestId": "340d95e7-4ea2-480c-958b-ca094141911f"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InsufficientBalance | 账户余额不足 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.SpecialParameterForSpecialAccount | 这个参数需要开启白名单才可以使用 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BandwidthNotSupported | 不支持此业务带宽 |
| UnsupportedOperation.BasicProtectBandwidthNotSupported | 不支持此保底防护带宽的取值 |
| UnsupportedOperation.ElasticProtectBandwidthNotSupported | 不支持此弹性带宽的取值 |
| UnsupportedOperation.InstanceChargeTypeNotSupported | 不支持此种付费类型 |
| UnsupportedOperation.PeriodNotSupported | 不支持该计费周期，参考对应高防包支持的计费周期 |
| UnsupportedOperation.ProtectIpCountNotSupported | 不支持该防护IP数量取值 |
| UnsupportedOperation.RegionNotSupported | 不支持此地域 |
