Tenant Cloud Network Virtual Private Cloud VPC APIs DescribeVpcs

DescribeVpcs

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

1. Interface Description

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

This API (DescribeVpcs) is used to query the list of VPCs.

Default interface request rate limit: 100 times per second.

Interface update time: 2020-04-17 00:08:55.

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: DescribeVpcs
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
VpcIds No No Array of String VPC instance ID, e.g., vpc-f49l6u0z. The upper limit of instances per request is 100. Parameters VpcIds and Filters must not be specified simultaneously.
Example: vpc-f49l6u0z
Filters No No Array of Filter Filter criteria. Parameters VpcIds and Filters must not be specified simultaneously.
  • vpc-name - String - (Filter criteria) VPC instance name.
  • is-default - String - (Filter criteria) Whether it is defaulted to VPC.
  • vpc-id - String - (Filter criteria) VPC instance ID, e.g., vpc-f49l6u0z.
  • cidr-block - String - (Filter criteria) CIDR of VPC.
  • tag-key - String - Required or Not: No - (Filter criteria) Filter by tag key.
  • 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 2 for usage.

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

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible objects.
    Example: 1
    VpcSet Array of Vpc VPC object.
    Example:View
    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
    UnauthorizedOperation Unauthorized operation
    InvalidParameter.Coexist The parameters must not be specified simultaneously.