Tenant Cloud Network Virtual Private Cloud VPC APIs DescribeUsedIpAddress

DescribeUsedIpAddress

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

1. Interface Description

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

This API (ApplyPrivateIpAddress) is used to query the usage of IP addresses in the subnet or VPC.
If the IP address is occupied, the resource category and ID of the occupied IP address are returned. If it is not occupied, a null value is returned.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-09-01 11:37:29.

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: DescribeUsedIpAddress
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
Filters No Yes Array of Filter Filtering condition. The IpAddresses and Filters parameters cannot be specified simultaneously. The supported filtering conditions are as follows: 
  • ip-addresses: IP address.
    •  
  • resource-id: resource ID.

    • Example:View
    Offset No Yes Uint64 Offset. 0 by default.
    Example: 0
    Limit No Yes Uint64 Number of returns, 20 by default, up to 100.
    Example: 10
    VpcId Yes Yes String VPC instance ID.
    Example: vpc-a26u781x
    SubnetId No Yes String Subnet instance ID.
    Example: subnet-amqye6ew
    IpAddresses No Yes Array of String Queries the list of occupied IP addresses. These IP addresses need to be within the VPC or subnet. Up to 100 IP addresses can be queried at a time.
    Example: ["192.168.2.10", "10.0.1.10"]

    3. Output Parameters

    Parameter name Type Description
    IpAddressStates Array of IpAddressStates Information on resources that occupy the IP addresses.
    Example:View
    TotalCount Uint64 Returns the number of occupied resources.
    Example: 1
    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.
    InvalidParameterValue.ParameterMismatch