Tenant Cloud Network Virtual Private Cloud ENI APIs DescribeNetworkInterfaces

DescribeNetworkInterfaces

Last Updated At: 2026-08-02 00:06:17

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeNetworkInterfaces) is used to query the ENI list.

Default interface request rate limit: 100 times per second.

Interface update time: 2025-04-28 20:28:11.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeNetworkInterfaces
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
NetworkInterfaceIds No No Array of String ENI instance ID query, e.g., eni-pxir56ns. The upper limit of instances per request is 100. Parameters NetworkInterfaceIds and Filters must not be specified simultaneously.
Example: ["eni-kiaim12s"]
Filters No No Array of Filter Filter criteria. Parameters NetworkInterfaceIds and Filters must not be specified simultaneously.
  • vpc-id - String - (Filter criteria) VPC instance ID, e.g., vpc-f49l6u0z.
  • subnet-id - String - (Filter criteria) Subnet instance ID, e.g., subnet-f49l6u0z.
  • network-interface-id - String - (Filter criteria) ENI instance ID, e.g., eni-5k56k7k7.
  • attachment.instance-id - String - (Filter criteria) Bound CVM instance ID, e.g., ins-3nqpdn3i.
  • groups.security-group-id - String - (Filter criteria) Bound security group instance ID, e.g., sg-f9ekbxeq.
  • network-interface-name - String - (Filter criteria) Network interface card instance name.
  • network-interface-description - String - (Filter criteria) Network interface card instance description.
  • address-ip - String - (Filter criteria) Private IPv4 address.
  • tag-key - String - Required or Not: No - (Filter criteria) Filter by tag key. Refer to example 2 for usage.
  • tag:tag-key - String - Required or Not: No - (Filter criteria) Filter by tag key-value pair. Replace tag-key with the specific tag key. Refer to example 3 for usage.
  • is-primary - Boolean - Required or Not: No - (Filter criteria) Filter by whether it is the primary network interface card. When the value is true, filter only the primary network interface card; when the value is false, filter only the auxiliary network interface card; when the filter parameter is not provided, filter both the primary and auxiliary network interface cards.

    • Example:View
    Offset No No Uint64 Offset. 0 by default.
    Example: 0
    Limit No No Uint64 Number of returns, 20 by default, up to 100.
    Example: 10

    3. Output Parameters

    Parameter name Type Description
    NetworkInterfaceSet Array of NetworkInterface Instance detail list.
    Example:View
    TotalCount Uint64 Number of eligible instances.
    Example:
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.Malformed Invalid input format.
    ResourceNotFound The resource does not exist
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    UnauthorizedOperation Unauthorized operation