tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNetworkInterfaces

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

1. API Description

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

This API is used to query the list of ENIs.

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: DescribeNetworkInterfaces.
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.
NetworkInterfaceIds.N No Array of String Queries the ID of the ENI instance, such as eni-pxir56ns. Each request supports a maximum of 100 instances. NetworkInterfaceIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Filter. NetworkInterfaceIds and Filters cannot be specified at the same time.
vpc-id - String - (Filter) VPC instance ID, such as vpc-f49l6u0z.
subnet-id - String - (Filter) Subnet instance ID, such as subnet-f49l6u0z.
network-interface-id - String - (Filter) ENI instance ID, such as eni-5k56k7k7.
attachment.instance-id - String - (Filter) ID of the bound CVM instance, such as ein-3nqpdn3i.
groups.security-group-id - String - (Filter) ID of the bound security group instance, such as sg-f9ekbxeq.
network-interface-name - String - (Filter) ENI instance name.
network-interface-description - String - (Filter) ENI instance description.
address-ip - String - (Filter) Private IPv4 address.
tag-key - String - Required: no - (Filter) Filter by tag key. For directions, see Sample 2.
tag:tag-key - String - Required: no - (Filter) Filter by tag key-value pair. Replace tag-key with the specific tag key. For directions, see Sample 3.
is-primary - Boolean - Required: no - (Filter) Filter by whether it is a primary ENI. true: filter only by primary ENI; false: filter only by secondary ENI. If this parameter is not specified, filtering by both primary and secondary ENIs will be used.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
EcmRegion No String ECM region, such as ap-xian-ecm.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible instances.
NetworkInterfaceSet Array of NetworkInterface List of instance details.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying ENI list

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeNetworkInterfaces
&<Common request parameters>

Output Example

{
    "Response": {
        "NetworkInterfaceSet": [
            {
                "NetworkInterfaceId": "eni-n1s3wvux",
                "NetworkInterfaceName": "String",
                "NetworkInterfaceDescription": "String",
                "SubnetId": "subnet-0790w1hs",
                "VpcId": "vpc-f3khnq0z",
                "GroupSet": [],
                "Primary": false,
                "MacAddress": "20:90:6F:6D:D9:B9",
                "State": "AVAILABLE",
                "PrivateIpAddressSet": [
                    {
                        "PrivateIpAddress": "10.0.0.8",
                        "Primary": true,
                        "PublicIpAddress": "",
                        "AddressId": "",
                        "Description": "",
                        "IsWanIpBlocked": false,
                        "State": "AVAILABLE"
                    }
                ],
                "Attachment": null,
                "Zone": "ap-hangzhou-ecm-1",
                "EcmRegion": "ap-hangzhou-ecm",
                "CreatedTime": "2020-08-20 15:26:42",
                "Ipv6AddressSet": [],
                "TagSet": [],
                "EniType": 0
            },
            {
                "NetworkInterfaceId": "eni-f1xjkw1b",
                "NetworkInterfaceName": "Security group test ENI",
                "NetworkInterfaceDescription": "Security group test ENI description",
                "SubnetId": "subnet-0790w1hs",
                "VpcId": "vpc-f3khnq0z",
                "GroupSet": [],
                "Primary": false,
                "MacAddress": "20:90:6F:69:1E:03",
                "State": "AVAILABLE",
                "PrivateIpAddressSet": [
                    {
                        "PrivateIpAddress": "10.0.0.16",
                        "Primary": true,
                        "PublicIpAddress": "",
                        "AddressId": "",
                        "Description": "",
                        "IsWanIpBlocked": false,
                        "State": "AVAILABLE"
                    }
                ],
                "Attachment": null,
                "Zone": "ap-hangzhou-ecm-1",
                "EcmRegion": "ap-hangzhou-ecm",
                "CreatedTime": "2020-08-20 16:02:14",
                "Ipv6AddressSet": [],
                "TagSet": [],
                "EniType": 0
            },
            {
                "NetworkInterfaceId": "eni-rb7kjij1",
                "NetworkInterfaceName": "Security group test ENI",
                "NetworkInterfaceDescription": "Security group test ENI description",
                "SubnetId": "subnet-5gnb2gls",
                "VpcId": "vpc-mbnu07m1",
                "GroupSet": [],
                "Primary": false,
                "MacAddress": "20:90:6F:90:0C:EF",
                "State": "AVAILABLE",
                "PrivateIpAddressSet": [
                    {
                        "PrivateIpAddress": "10.0.0.9",
                        "Primary": true,
                        "PublicIpAddress": "",
                        "AddressId": "",
                        "Description": "",
                        "IsWanIpBlocked": false,
                        "State": "AVAILABLE"
                    }
                ],
                "Attachment": null,
                "Zone": "ap-qingdao-ecm-1",
                "EcmRegion": "ap-qingdao-ecm",
                "CreatedTime": "2020-09-08 10:58:51",
                "Ipv6AddressSet": [],
                "TagSet": [],
                "EniType": 0
            }
        ],
        "TotalCount": 3,
        "RequestId": "8f7fb33d-642f-43d7-bc8f-2d17efbfb49c"
    }
}

5. Developer Resources

SDK

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
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameterValue.InvalidFilter The filter is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
InvalidParameterValue.Malformed The input parameter format is invalid.
InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
MissingParameter The parameter is missing.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy