Documentation|Tencent Cloud

Recent Pages

Documentation

CreateNetworkInterface

Last updated: 2020-07-31 14:30:55

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create one or more ENIs.

You can specify private IP addresses and a primary IP when creating an ENI. The specified private IP must be in the same subnet as the ENI and is not occupied.
When creating an ENI, you can specify the number of private IP addresses that you want to apply for. The system will randomly generate private IP addresses.
An ENI can only be bound with a limited number of IP addresses. For more information about resource limits, see ENI Use Limits.
You can bind an existing security group when creating an ENI.
You can bind a tag when creating an ENI. The tag list in the response indicates the tags that have been successfully added.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: CreateNetworkInterface.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. 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 that is newly applied for. The total number of private IP addresses cannot exceed the quota.
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"}].

3. Output Parameters

Parameter Name	Type	Description
NetworkInterface	NetworkInterface	ENI instance.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an ENI

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateNetworkInterface
&Version=2017-03-12
&VpcId=vpc-0akbol5v
&SubnetId=subnet-76r802pg
&NetworkInterfaceName=TestNIC
&NetworkInterfaceDescription=TestDesc
&PrivateIpAddresses.0.PrivateIpAddress=172.16.64.13
&PrivateIpAddresses.0.Primary=true
&SecondaryPrivateIpAddressCount=1
&SecurityGroupIds.0=sg-05bb4upy
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<Common request parameters>

Output Example

{
    "Response": {
        "NetworkInterface": {
            "NetworkInterfaceId": "eni-irk5qhhl",
            "VpcId": "vpc-0akbol5v",
            "SubnetId": "subnet-76r802pg",
            "NetworkInterfaceName": "TestNIC",
            "NetworkInterfaceDescription": "TestDesc",
            "MacAddress": "20:90:6F:62:33:E2",
            "PrivateIpAddressSet": [
                {
                    "PrivateIpAddress": "172.16.64.13",
                    "Primary": true
                    "AddressId": "",
                    "PublicIpAddress": "",
                    "Description": "",
                    "IsWanIpBlocked": false,
                    "State": "PENDING"
                }
            ],
            "Attachment": null,
            "GroupSet": [],
            "Primary": false,
            "State": "PENDING",
            "Zone": "",
            "CreatedTime": "",
            "Ipv6AddressSet": [],
            "TagSet": [
                {
                    "Key": "city",
                    "Value": "shanghai"
                }
            ]
        },
        "RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"
    }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue	Invalid parameter value
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.TooLong	Invalid parameter value. The parameter value is too long.
LimitExceeded	Quota limit is reached.
MissingParameter	Parameter missing. A required parameter is missing in the request.
ResourceInUse	The resource is occupied.
ResourceInsufficient	Insufficient resources.
ResourceNotFound	The resource does not exist.