Tenant Cloud Network Virtual Private Cloud CCN APIs DescribeCcnAttachedInstances

DescribeCcnAttachedInstances

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

1. Interface Description

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

This API (DescribeCcnAttachedInstances) is used to query the network instances associated with a CCN instance.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-01-23 01:17:29.

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: DescribeCcnAttachedInstances
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
Offset No No Uint64 Offset
Example: 0
Limit No No Uint64 Returned quantity
Example: 20
Filters No No Array of Filter Filters:
  • ccn-id - String - (Filters) CCN instance ID.
  • instance-type - String - (Filters) Type of associated instance.
  • instance-region - String - (Filters) Region of the associated instance.
  • instance-id - String - (Filters) Associated instance ID.

    • Example:View
    CcnId No No String CCN instance ID
    Example: ccn-245ecr35
    OrderField No No String Sorting fields. Supports CcnId, InstanceType, InstanceId, InstanceName, InstanceRegion, AttachedTime, and State.
    Example: CcnId
    OrderDirection No No String Sorting method. ASC: Ascending order, DESC: Descending order.
    Example: ASC

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible objects.
    Example:
    InstanceSet Array of CcnAttachedInstance Associated instance list.
    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

    There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.