1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
本接口用于给IPv6地址分配公网带宽
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AllocateIpv6AddressesBandwidth。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EcmRegion | 是 | String | ECM 地域。 示例值:ap-xian-ecm |
Ipv6Addresses.N | 是 | Array of String | 需要开通公网访问能力的IPV6地址。 |
InternetMaxBandwidthOut | 否 | Integer | 带宽,单位Mbps,默认是1Mbps。 示例值:1 |
InternetChargeType | 否 | String | 网络计费模式,当前支持 BANDWIDTH_PACKAGE。 示例值:BANDWIDTH_PACKAGE |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AddressSet | Array of String | 弹性公网 IPV6 的唯一 ID 列表。 注意:此字段可能返回 null,表示取不到有效值。 |
TaskId | String | 异步任务TaskId。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 指定ipv6地址开通公网访问能力
输入示例
https://ecm.tencentcloudapi.com/?Action=AllocateIpv6AddressesBandwidth
&EcmRegion=ap-xian-ecm
&Ipv6Addresses.0=2402:4e00:1000:200:0:8d8a:60b7:87f8
&<公共请求参数>
输出示例
{
"Response": {
"AddressSet": [
"eip-3l4nwzvo"
],
"TaskId": 202869021,
"RequestId": "aac03e7b-3c91-4970-b2bc-c20f0c6bdd38"
}
}
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.InvalidDataFormat | 数据格式不正确。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidBandwidth | 带宽大小不合法。 |
InvalidParameterValue.InvalidEcmRegion | 地域参数不合法。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.SubnetConflict | 指定CIDR与同一个私有网络内的另一个子网发生冲突。 |
InvalidParameterValue.UnsupportedRegion | 不支持该区域。 |
InvalidParameterValue.UserNotSupportIPv6 | 用户不支持ipv6。 |
LimitExceeded.AddressQuotaLimitExceeded | 申请数量超限。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |