tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNetworkInterfaceLimit

Last updated: 2024-11-25 20:09:21

    1. API Description

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

    This API (DescribeNetworkInterfaceLimit) is used to query the ENI quota based on the ID of CVM instance or ENI. It returns the ENI quota to which the CVM instance can be bound and the IP address quota that can be allocated to the 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: DescribeNetworkInterfaceLimit.
    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.
    InstanceId Yes String ID of a CVM instance or ENI to query

    3. Output Parameters

    Parameter Name Type Description
    EniQuantity Integer Quota of ENIs mounted to a CVM instance in a standard way
    EniPrivateIpAddressQuantity Integer Quota of IP addresses that can be allocated to each standard-mounted ENI
    ExtendEniQuantity Integer Quota of ENIs mounted to a CVM instance as an extension
    Note: this field may return null, indicating that no valid values can be obtained.
    ExtendEniPrivateIpAddressQuantity Integer Quota of IP addresses that can be allocated to each extension-mounted ENI.
    Note: this field may return null, indicating that no valid values can be obtained.
    SubEniQuantity Integer The quota of relayed ENIs
    Note: This field may return null, indicating that no valid values can be obtained.
    SubEniPrivateIpAddressQuantity Integer The quota of IPs that can be assigned to each relayed ENI.
    Note: This field may return null, indicating that no valid values can be obtained.
    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.

    4. Example

    Example1 Querying the ENI quota by CVM instance ID

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=DescribeNetworkInterfaceLimit
&InstanceId=ins-1991090i
&<common request parameters>

    Output Example

    {
    "Response": {
        "EniPrivateIpAddressQuantity": 10,
        "ExtendEniPrivateIpAddressQuantity": 20,
        "ExtendEniQuantity": 0,
        "RequestId": "01f14f34-e9ae-470d-a71b-e8616ad3fae1",
        "EniQuantity": 2,
        "SubEniQuantity": 0,
        "SubEniPrivateIpAddressQuantity": 0
    }
}

    Example2 Querying the ENI quota by ENI ID

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=DescribeNetworkInterfaceLimit
&InstanceId=eni-1991090i
&<common request parameters>

    Output Example

    {
    "Response": {
        "EniQuantity": 0,
        "EniPrivateIpAddressQuantity": 10,
        "ExtendEniQuantity": 0,
        "ExtendEniPrivateIpAddressQuantity": 0,
        "RequestId": "01f14f34-e9ae-470d-a71b-e8616ad3fae1",
        "SubEniQuantity": 0,
        "SubEniPrivateIpAddressQuantity": 0
    }
}

    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
    InternalError.ModuleError Internal module error
    InternalServerError Internal error.
    InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.
    InvalidParameterValue.Malformed Invalid input parameter format.
    LimitExceeded.ActionLimited Too often API invocations
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy