Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to create an ENI.
Note：
This API is async. You can call the
DescribeVpcTaskResultAPI to query the task result. When the task is completed, you can continue other tasks.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateNetworkInterface. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| VpcId | Yes | String | The ID of the VPC instance. You can obtain the parameter value from the VpcId field in the returned result of DescribeVpcs API. |
| NetworkInterfaceName | Yes | String | The name of the ENI. The maximum length is 60 characters. |
| SubnetId | Yes | String | The subnet instance ID of the ENI, such as subnet-0ap8nwca. |
| NetworkInterfaceDescription | No | String | ENI description can be named freely, but the maximum length is 60 characters. |
| SecondaryPrivateIpAddressCount | No | Integer | The number of private IP addresses you apply for. The total number of private IP addresses cannot exceed the quota. |
| QosLevel | No | String | IP service level. It is used together with SecondaryPrivateIpAddressCount. Values: PT (Gold), AU (Silver), AG (Bronze) and DEFAULT (Default). |
| SecurityGroupIds.N | No | Array of String | Specifies the security group to be bound with, such as ['sg-1dd51d']. |
| PrivateIpAddresses.N | No | Array of PrivateIpAddressSpecification | The information of the specified private IPs. You can specify a maximum of 10 each time. |
| Tags.N | No | Array of Tag | Bound tags, such as [{"Key": "city", "Value": "shanghai"}]. |
| TrunkingFlag | No | String | Configuration of the ENI trunking mode. Valid values: Enable and Disable. Default value: Disable. |
| ClientToken | No | String | Idempotency token used to ensure request idempotency. This string is generated by the client and must be unique across different requests, with a maximum length of 64 ASCII characters. If this parameter is not specified, request idempotency cannot be guaranteed. |
| Parameter Name | Type | Description |
|---|---|---|
| NetworkInterface | NetworkInterface | ENI instance. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create an ENI.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNetworkInterface
<Common request parameters>
{
"VpcId": "vpc-0akbol5v",
"Tags": [
{
"Value": "shanghai",
"Key": "city"
}
],
"PrivateIpAddresses": [
{
"Primary": "true",
"PrivateIpAddress": "172.16.64.13"
}
],
"SecurityGroupIds": [
"sg-05bb4upy"
],
"NetworkInterfaceDescription": "TestDesc",
"SecondaryPrivateIpAddressCount": "1",
"SubnetId": "subnet-76r802pg",
"NetworkInterfaceName": "TestNIC"
}
{
"Response": {
"NetworkInterface": {
"NetworkInterfaceId": "abc",
"NetworkInterfaceName": "abc",
"NetworkInterfaceDescription": "abc",
"SubnetId": "abc",
"VpcId": "abc",
"GroupSet": [
"abc"
],
"Primary": true,
"MacAddress": "abc",
"State": "abc",
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "abc",
"Primary": true,
"PublicIpAddress": "abc",
"AddressId": "abc",
"Description": "abc",
"IsWanIpBlocked": true,
"State": "abc",
"QosLevel": "abc"
}
],
"Attachment": {
"InstanceId": "abc",
"DeviceIndex": 1,
"InstanceAccountId": "abc",
"AttachTime": "abc"
},
"Zone": "abc",
"CreatedTime": "abc",
"Ipv6AddressSet": [
{
"Address": "abc",
"Primary": true,
"AddressId": "abc",
"Description": "abc",
"IsWanIpBlocked": true,
"State": "abc"
}
],
"TagSet": [
{
"Key": "abc",
"Value": "abc"
}
],
"EniType": 1,
"Business": "abc",
"CdcId": "abc",
"AttachType": 1,
"ResourceId": "abc",
"QosLevel": "abc"
},
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.NetDetectTimeOut | Network probe timed out. Please retry later. |
| InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
| InvalidParameter.FilterNotDict | The specified filter condition should be a key-value pair. |
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| InvalidParameterValue.Reserved | The parameter value is retained by the system. |
| InvalidParameterValue.TagDuplicateKey | Duplicate tag keys. |
| InvalidParameterValue.TagDuplicateResourceType | Duplicate tag resource type. |
| InvalidParameterValue.TagInvalidKey | Invalid tag key. |
| InvalidParameterValue.TagInvalidKeyLen | Invalid tag key length. |
| InvalidParameterValue.TagInvalidVal | Invalid tag key. |
| InvalidParameterValue.TagKeyNotExists | The tag key does not exist. |
| InvalidParameterValue.TagNotAllocatedQuota | Tags are not assigned quotas. |
| InvalidParameterValue.TagNotExisted | The Tag does not exist. |
| InvalidParameterValue.TagNotSupportTag | Unsupported tag. |
| InvalidParameterValue.TagResourceFormatError | Tag resource format error. |
| InvalidParameterValue.TagTimestampExceeded | Exceeded the quota of tag timestamp. |
| InvalidParameterValue.TagValNotExists | The tag value does not exist. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| LimitExceeded | Quota limit is reached. |
| LimitExceeded.ActionLimited | Too often API invocations |
| LimitExceeded.NetworkInterfaceLimitExceeded | The number of elastic network interfaces created in the VPC exceeds the quota. |
| LimitExceeded.TagKeyExceeded | Reached the upper limit of tag keys. |
| LimitExceeded.TagKeyPerResourceExceeded | Reached the upper limit of tags keys per resource. |
| LimitExceeded.TagNotEnoughQuota | Insufficient tag quota. |
| LimitExceeded.TagQuota | Exceeded the tag quota. Unable to create resources. |
| LimitExceeded.TagQuotaExceeded | Reached the upper limit of tag quota. |
| LimitExceeded.TagTagsExceeded | Reached the number limit of tag keys. |
| MissingParameter | Missing parameter. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceInsufficient.Subnet | The subnet does not have sufficient IPs. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.IdempotentParameterMismatch | The specified customer token has been used. |
| UnsupportedOperation.IdempotentProcessing | The previous idempotent request is still being processed. Please try again later. |
| UnsupportedOperation.ResourceMismatch | The resource ID entered does not match with any resource bound with the IP. Check and try again. |
| UnsupportedOperation.TagAllocate | Tags are being assigned. |
| UnsupportedOperation.TagFree | Tags are being released. |
| UnsupportedOperation.TagNotPermit | Unauthorized for this tag. |
| UnsupportedOperation.TagSystemReservedTagKey | The specified tag key is reserved for system usage. |
피드백