PrevNext
search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeCcnAttachedInstances

    Last updated: 2021-04-06 11:10:10
    Download PDF

    1. API Description

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

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

    A maximum of 100 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeCcnAttachedInstances.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Offset No Integer Offset
    Limit No Integer The returned quantity
    Filters.N No Array of Filter Filter conditions:
  • ccn-id - String - (Filter condition) The CCN instance ID.
  • instance-type - String - (Filter condition) The associated instance type.
  • instance-region - String - (Filter condition) The associated instance region.
  • instance-type - String - (Filter condition) The instance ID of the associated instance.
    		•
    CcnId No String The ID of the CCN instance
    OrderField No String The order field supports CcnId, InstanceType, InstanceId, InstanceName, InstanceRegion, AttachedTime, and State.
    OrderDirection No String Order methods. Ascending: ASC, Descending: DESC.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of objects meeting the condition.
    InstanceSet Array of CcnAttachedInstance The list of associated instances.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of CCN-associated instances

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeCcnAttachedInstances
&<Common request parameters>
&Filters.0.Name=ccn-id
&Filters.0.Values.0=ccn-gree226l
&Filters.1.Name=instance-id
&Filters.1.Values.0=vpc-2u0s99fx
&Filters.1.Values.1=vpc-r1ckkpid
&Filters.1.Values.2=vpc-3dr1zrr9
&Filters.1.Values.3=dcg-98qosdc3
&Filters.1.Values.4=dcg-ni7ps9kb

    Output Example

    {
  "Response": {
    "InstanceSet": [
      {
        "CcnId": "ccn-gree226l",
        "InstanceType": "VPC",
        "InstanceId": "vpc-2u0s99fx",
        "InstanceName": "test1",
        "InstanceRegion": "ap-guangzhou",
        "InstanceUin": "38059483",
        "CidrBlock": [
          "10.0.0.0/16"
        ],
        "State": "PENDING"
      },
      {
        "CcnId": "ccn-gree226l",
        "InstanceType": "VPC",
        "InstanceId": "vpc-r1ckkpid",
        "InstanceName": "vpc0420",
        "InstanceRegion": "ap-guangzhou",
        "InstanceUin": "88419914",
        "CidrBlock": [
          "10.33.0.0/16"
        ],
        "State": "REJECTED"
      },
      {
        "CcnId": "ccn-gree226l",
        "InstanceType": "VPC",
        "InstanceId": "vpc-3dr1zrr9",
        "InstanceName": "10.100.0.0/16",
        "InstanceRegion": "ap-guangzhou",
        "InstanceUin": "979137",
        "CidrBlock": [
          "10.100.0.0/16"
        ],
        "State": "ACTIVE"
      },
      {
        "CcnId": "ccn-gree226l",
        "InstanceType": "DIRECTCONNECT",
        "InstanceId": "dcg-98qosdc3",
        "InstanceName": "",
        "InstanceRegion": "ap-guangzhou",
        "InstanceUin": "979137",
        "CidrBlock": [
          "192.168.0.0/24"
        ],
        "State": "ACTIVE"
      },
      {
        "CcnId": "ccn-gree226l",
        "InstanceType": "DIRECTCONNECT",
        "InstanceId": "dcg-ni7ps9kb",
        "InstanceName": "",
        "InstanceRegion": "ap-guangzhou",
        "InstanceUin": "979137",
        "CidrBlock": [
          "192.168.1.0/24"
        ],
        "State": "ACTIVE"
      }
    ],
    "TotalCount": 5,
    "RequestId": "0227fa04-3298-470c-8477-149f309a386a"
  }
}

    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
    InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameter.FilterNotDict The specified filter condition should be a key-value pair.
    InvalidParameter.FilterValuesNotList The specified filter value should be a list.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy