Tenant Cloud Network Virtual Private Cloud Direct Connect Gateway APIs DescribeDirectConnectGateways

DescribeDirectConnectGateways

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

1. Interface Description

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

This API (DescribeDirectConnectGateways) is used to query Direct Connect gateways.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-08-29 04:01:58.

The interface is both signature verification and authentication.

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: DescribeDirectConnectGateways
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
DirectConnectGatewayIds No No Array of String Unique ID of Direct Connect gateway, e.g., dcg-9o233uri.
Example: ["dcg-dimeg9zd\r\n","dcg-6eeis68f\r\n","dcg-94cdyvfr\r\n"]
Filters No No Array of Filter Filters. Parameters DirectConnectGatewayIds and Filters must not be specified simultaneously.
  • direct-connect-gateway-id - String - Unique ID of the Direct Connect gateway, e.g., dcg-9o233uri.
  • direct-connect-gateway-name - String - Name of the Direct Connect gateway, fuzzy search by default.
  • direct-connect-gateway-ip - String - IP of the Direct Connect gateway.
  • gateway-type - String - Gateway type, options: NORMAL (Standard), NAT (NAT type).
  • network-type - String - Network type, options: VPC (VPC type), CCN (CCN type).
  • ccn-id - String - CCN ID where the Direct Connect gateway is located.
  • vpc-id - String - VPC ID where the Direct Connect gateway is located.

    • Example:View
    Offset No No Uint64 Offset.
    Example: 0
    Limit No No Uint64 Returned quantity.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible objects.
    Example: 1
    DirectConnectGatewaySet Array of DirectConnectGateway Direct Connect gateway object array.
    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 The parameter value is invalid.
    InvalidParameterValue.Malformed Invalid input format.
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    InvalidParameterValue.TooLong Invalid input: Excessive length of the parameter.