1. 接口描述
接口请求域名: vpc.api3.gsesgpucloud.com。
本接口(AssignIpv6Addresses)用于弹性网卡申请IPv6
地址。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的RequestId
轮询QueryTask
接口。
- 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。
- 可以指定
IPv6
地址申请,地址类型不能为主IP
,IPv6
地址暂时只支持作为辅助IP
。 - 地址必须要在弹性网卡所在子网内,而且不能被占用。
- 在弹性网卡上申请一个到多个辅助
IPv6
地址,接口会在弹性网卡所在子网段内返回指定数量的辅助IPv6
地址。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-03-30 20:51:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:AssignIpv6Addresses |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
NetworkInterfaceId | 是 | 否 | String | 弹性网卡实例ID ,形如:eni-m6dyj72l 。示例值: |
Ipv6Addresses | 否 | 否 | Array of Ipv6Address | 指定的IPv6 地址列表,单次最多指定10个。与入参Ipv6AddressCount 合并计算配额。与Ipv6AddressCount必填一个。示例值:查看 |
Ipv6AddressCount | 否 | 否 | Uint64 | 自动分配IPv6 地址个数,内网IP地址个数总和不能超过配数。与入参Ipv6Addresses 合并计算配额。与Ipv6Addresses必填一个。示例值: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Ipv6AddressSet | Ipv6Address | 分配给弹性网卡的IPv6 地址列表。示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数值不合法。 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
MissingParameter | 参数缺失。请求没有带必选参数。 |
LimitExceeded.Address | 分配IP地址数量达到上限。 |
UnsupportedOperation.UnassignCidrBlock | 未分配IPv6网段。 |
ResourceInUse.Address | 指定IP地址已经在使用中。 |
UnsupportedOperation.MutexOperationTaskRunning | 资源互斥操作任务正在执行。 |