1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateAndAttachNetworkInterface)用于创建弹性网卡并绑定云服务器。
- 创建弹性网卡时可以指定内网IP,并且可以指定一个主IP,指定的内网IP必须在弹性网卡所在子网内,而且不能被占用。
- 创建弹性网卡时可以指定需要申请的内网IP数量,系统会随机生成内网IP地址。
- 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。
- 创建弹性网卡同时可以绑定已有安全组。
- 创建弹性网卡同时可以绑定标签, 应答里的标签列表代表添加成功的标签。
说明:
本接口为异步接口,可调用 DescribeVpcTaskResult 接口查询任务执行结果,待任务执行成功后再进行其他操作。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAndAttachNetworkInterface。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。 示例值:vpc-m0c2kcun |
NetworkInterfaceName | 是 | String | 弹性网卡名称,最大长度不能超过60个字节。 示例值:eni-ed3452de |
SubnetId | 是 | String | 弹性网卡所在的子网实例ID,例如:subnet-0ap8nwca。 示例值:subnet-76r802pg |
InstanceId | 是 | String | 云服务器实例ID。 示例值:ins-12345678 |
PrivateIpAddresses.N | 否 | Array of PrivateIpAddressSpecification | 指定的内网IP信息,单次最多指定10个。 示例值:10.0.0.0 |
SecondaryPrivateIpAddressCount | 否 | Integer | 新申请的内网IP地址个数,内网IP地址个数总和不能超过配额数。 示例值:10.0.0.2 |
QosLevel | 否 | String | IP服务质量等级,和SecondaryPrivateIpAddressCount配合使用,可选值:PT、AU、AG、DEFAULT,分别代表云金、云银、云铜、默认四个等级。 示例值:PT |
SecurityGroupIds.N | 否 | Array of String | 指定绑定的安全组,例如:['sg-1dd51d']。 示例值:-- |
NetworkInterfaceDescription | 否 | String | 弹性网卡描述,可任意命名,但不得超过60个字符。 示例值:uiui |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。 示例值:-- |
AttachType | 否 | Integer | 绑定类型:0 标准型 1 扩展型。 示例值:1 |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NetworkInterface | NetworkInterface | 弹性网卡实例。 示例值:-- |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建弹性网卡并绑定云服务器
创建弹性网卡并绑定云服务器
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAndAttachNetworkInterface
<公共请求参数>
{
"VpcId": "vpc-0akbol5v",
"Tags": [
{
"Value": "shanghai",
"Key": "city"
}
],
"InstanceId": "ins-12345678",
"PrivateIpAddresses": [
{
"Primary": "true",
"PrivateIpAddress": "172.16.64.13"
}
],
"SecurityGroupIds": [
"sg-05bb4upy"
],
"NetworkInterfaceDescription": "TestDesc",
"SecondaryPrivateIpAddressCount": "1",
"SubnetId": "subnet-76r802pg",
"NetworkInterfaceName": "TestNIC"
}
输出示例
{
"Response": {
"NetworkInterface": {
"NetworkInterfaceId": "eni-irk5qhhl",
"VpcId": "vpc-0akbol5v",
"SubnetId": "subnet-76r802pg",
"NetworkInterfaceName": "TestNIC",
"NetworkInterfaceDescription": "TestDesc",
"MacAddress": "20:90:6F:62:33:E2",
"Business": "TKE",
"CdcId": "",
"EniType": 1,
"AttachType": 1,
"QosLevel": "DEFAULT",
"ResourceId": "",
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "172.16.64.13",
"Primary": true,
"AddressId": "",
"PublicIpAddress": "",
"Description": "",
"IsWanIpBlocked": false,
"State": "PENDING",
"QosLevel": "DEFAULT"
}
],
"Attachment": {
"InstanceId": "ins-12345678"
},
"GroupSet": [],
"Primary": false,
"State": "PENDING",
"Zone": "",
"CreatedTime": "",
"Ipv6AddressSet": [],
"TagSet": [
{
"Key": "city",
"Value": "shanghai"
}
]
},
"RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"
}
}
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.FilterInvalidKey | 指定过滤条件不存在。 |
InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.Reserved | 参数值是一个系统保留对象。 |
InvalidParameterValue.TagDuplicateKey | 标签键重复。 |
InvalidParameterValue.TagDuplicateResourceType | 重复的标签资源类型。 |
InvalidParameterValue.TagInvalidKey | 标签键无效。 |
InvalidParameterValue.TagInvalidKeyLen | 标签键长度无效。 |
InvalidParameterValue.TagInvalidVal | 标签值无效。 |
InvalidParameterValue.TagKeyNotExists | 标签键不存在。 |
InvalidParameterValue.TagNotAllocatedQuota | 标签没有分配配额。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.TagNotSupportTag | 不支持的标签。 |
InvalidParameterValue.TagResourceFormatError | 标签资源格式错误。 |
InvalidParameterValue.TagTimestampExceeded | 标签时间戳超配。 |
InvalidParameterValue.TagValNotExists | 标签值不存在。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.TagKeyExceeded | 标签键已达到上限。 |
LimitExceeded.TagKeyPerResourceExceeded | 每个资源的标签键已达到上限。 |
LimitExceeded.TagNotEnoughQuota | 没有足够的标签配额。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
LimitExceeded.TagQuotaExceeded | 标签配额已达到上限。 |
LimitExceeded.TagTagsExceeded | 标签键的数目已达到上限。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Subnet | 子网IP资源不足, 无法分配IP。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.IdempotentParameterMismatch | 指定的客户令牌已经被使用。 |
UnsupportedOperation.IdempotentProcessing | 先前的幂等请求仍在处理中,请稍后重试。 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
UnsupportedOperation.ResourceMismatch | 输入的资源ID与IP绑定的资源不匹配,请检查。 |
UnsupportedOperation.TagAllocate | 标签正在分配中。 |
UnsupportedOperation.TagFree | 标签正在释放中。 |
UnsupportedOperation.TagNotPermit | 标签没有权限。 |
UnsupportedOperation.TagSystemReservedTagKey | 不支持使用系统预留的标签键。 |
UnsupportedOperation.UnsupportedInstanceFamily | 指定机型不支持弹性网卡。 |
UnsupportedOperation.VpcMismatch | 资源不属于同一个VPC。 |