tencent cloud



Last updated: 2023-08-18 14:28:13

1. API Description

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

This API is used to create an ENI.

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

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 Params. The value used for this API: CreateNetworkInterface.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
VpcId Yes String VPC instance ID, which can be obtained from the VpcId field in the returned value of the DescribeVpcs API.
NetworkInterfaceName Yes String ENI name, which can contain up to 60 bytes.
SubnetId Yes String Subnet instance ID of the ENI, such as 'subnet-0ap8nwca'.
EcmRegion Yes String ECM region, such as ap-xian-ecm.
NetworkInterfaceDescription No String ENI description. You can enter any information within 60 characters.
SecondaryPrivateIpAddressCount No Integer Number of private IP addresses applied for. The total number of private IP addresses cannot exceed the quota.
SecurityGroupIds.N No Array of String The security group to be bound with, such as ['sg-1dd51d'].
PrivateIpAddresses.N No Array of PrivateIpAddressSpecification Information of the specified private IPs. You can specify up to 10 IPs at a time.
Tags.N No Array of Tag List of 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 ENI

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "NetworkInterface": {
            "NetworkInterfaceId": "eni-12121212",
            "VpcId": "vpc-1111111",
            "SubnetId": "subnet-22222222",
            "NetworkInterfaceName": "Test",
            "NetworkInterfaceDescription": "Test",
            "MacAddress": "20:90:6F:62:33:E2",
            "PrivateIpAddressSet": [
                    "PrivateIpAddress": "",
                    "Primary": true,
                    "AddressId": "",
                    "PublicIpAddress": "",
                    "Description": "",
                    "IsWanIpBlocked": false,
                    "State": "PENDING"
            "Attachment": null,
            "GroupSet": [],
            "Primary": false,
            "State": "PENDING",
            "Zone": "ap-hangzhou-ecm-1",
            "CreatedTime": "",
            "Ipv6AddressSet": [],
            "EcmRegion": "ap-hangzhou-ecm",
            "EniType": 0,
            "TagSet": []
        "RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"

5. Developer Resources


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

Command Line Interface

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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed The input parameter format is invalid.
InvalidParameterValue.Range The parameter value is not in the specified range.
InvalidParameterValue.Reserved The parameter value is an object retained by the system.
LimitExceeded The quota limit is exceeded.
LimitExceeded.EniQuotaLimitExceeded The number of purchasable ENIs is insufficient.
MissingParameter The parameter is missing.
MissingParameter.MissingNetworkInterfaceParameter The request parameters required for ENI operation configuration are missing.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support