Queries Cloud Connect Network (CCN) instances that you have created in a specific region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-shanghai

The ID of the region where the CCN instances are deployed.

Name String No ccnname

The name of the CCN instance.

The name must be 2 to 100 characters in length and can contain letters, digits, periods (.), underscores (_),and hyphens (-). The name must start with a letter.

CcnId String No ccn-l9340rlu5enst*****

The ID of the CCN instance.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 50.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

Action String Yes DescribeCloudConnectNetworks

The operation that you want to perform. Set the value to DescribeCloudConnectNetworks.

Tag.N.Key String No test

The key of the tag that is bound to the CCN instance.

Tag.N.Value String No test

The value of the tag that is bound to the CCN instance.

Response parameters

Parameter Type Example Description
CloudConnectNetworks Array of CloudConnectNetwork

The list of CCN instances.

CloudConnectNetwork
CreateTime Long 1523618639000

The timestamp when the CCN instance was created.

AssociatedCenOwnerId String 168800000000****

The account ID of the Cloud Enterprise Network (CEN) instance to which the CCN instance is attached.

AssociatedCloudBoxCount String 1

The number of Smart Access Gateway (SAG) instances that are associated with the CCN instance.

Tags Array of Tag

The list of tags.

Tag
Key String test

The key of the tag that is bound to the CCN instance.

Value String test

The value of the tag that is bound to the CCN instance.

InterworkingStatus String enable

Indicates whether the SAG instances that are associated with the same CCN instance communicate with each other.

  • enable: allows SAG instances that are associated with the same CCN instance to communicate with each other.
  • disable: does not allow SAG instances that are associated with the same CCN instance to communicate with each other.
CcnId String ccn-l9340rlu5enst******

The ID of the CCN instance.

AvailableCloudBoxCount String 1

The number of SAG instances in the Available state that are associated with the CCN instance.

CidrBlock String 10.10.10.0/24

The private CIDR block.

Description String ccndesc

The description of the CCN instance.

SnatCidrBlock String 10.10.10.0/25

The CIDR block that is used in Source Network Address Translation (SNAT).

AssociatedCenId String cen-0jtu0bcbika5b5****

The ID of the CEN instance to which the CCN instance is attached.

Name String ccnname

The name of the CCN instance.

ResourceGroupId String rg-acfm2iu4fnc****

The ID of the resource group to which the CCN instance belongs.

TotalCount Integer 3

The total number of the CCN instances.

PageSize Integer 10

The number of entries returned per page.

RequestId String 3F2A0B80-D6D1-4764-8D77-38067DBBA345

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-shanghai
&Name=ccnname
&CcnId=ccn-l9340rlu5enst*****
&PageSize=10
&PageNumber=1
&Action=DescribeCloudConnectNetworks
&Tag=[{"Key":"test","Value":"test"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCloudConnectNetworksResponse>
    <CloudConnectNetworks>
        <CloudConnectNetwork>
            <IsDefault>false</IsDefault>
            <InterworkingStatus>enable</InterworkingStatus>
            <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
            <CreateTime>1604385674000</CreateTime>
            <CcnId>ccn-iz26o9zye6lhoo****</CcnId>
            <AvailableCloudBoxCount>1</AvailableCloudBoxCount>
            <AssociatedCenOwnerId>1688000000000000</AssociatedCenOwnerId>
            <AssociatedCenId>cen-9z595pdzhmi3jz****</AssociatedCenId>
            <AssociatedCloudBoxCount>1</AssociatedCloudBoxCount>
            <Name>zxtest-202106</Name>
        </CloudConnectNetwork>
        <CloudConnectNetwork>
            <IsDefault>false</IsDefault>
            <InterworkingStatus>enable</InterworkingStatus>
            <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
            <CreateTime>1594619327000</CreateTime>
            <CcnId>ccn-frx6evdue4daza****</CcnId>
            <AvailableCloudBoxCount>3</AvailableCloudBoxCount>
            <AssociatedCenOwnerId>1688000000000000</AssociatedCenOwnerId>
            <AssociatedCenId>cen-ol0xptl3edqc8i****</AssociatedCenId>
            <AssociatedCloudBoxCount>3</AssociatedCloudBoxCount>
            <Name>zxtest-OSS</Name>
        </CloudConnectNetwork>
        <CloudConnectNetwork>
            <IsDefault>false</IsDefault>
            <InterworkingStatus>enable</InterworkingStatus>
            <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
            <CreateTime>1589866291000</CreateTime>
            <CcnId>ccn-wf0kz6wohe03h2****</CcnId>
            <AvailableCloudBoxCount>1</AvailableCloudBoxCount>
            <AssociatedCenOwnerId>1688000000000000</AssociatedCenOwnerId>
            <CidrBlock>192.168.10.0/24</CidrBlock>
            <AssociatedCenId>cen-8z69wtwqel33lq****</AssociatedCenId>
            <AssociatedCloudBoxCount>1</AssociatedCloudBoxCount>
            <Name>zxtest</Name>
        </CloudConnectNetwork>
    </CloudConnectNetworks>
    <TotalCount>3</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>7DA93FE9-D008-49FB-8D9B-186F509EA307</RequestId>
    <PageNumber>1</PageNumber>
</DescribeCloudConnectNetworksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CloudConnectNetworks" : {
    "CloudConnectNetwork" : [ {
      "IsDefault" : false,
      "InterworkingStatus" : "enable",
      "ResourceGroupId" : "rg-acfm2iu4fnc****",
      "CreateTime" : 1604385674000,
      "CcnId" : "ccn-iz26o9zye6lhoo****",
      "AvailableCloudBoxCount" : 1,
      "AssociatedCenOwnerId" : 1688000000000000,
      "AssociatedCenId" : "cen-9z595pdzhmi3jz****",
      "AssociatedCloudBoxCount" : 1,
      "Name" : "zxtest-202106"
    }, {
      "IsDefault" : false,
      "InterworkingStatus" : "enable",
      "ResourceGroupId" : "rg-acfm2iu4fnc****",
      "CreateTime" : 1594619327000,
      "CcnId" : "ccn-frx6evdue4daza****",
      "AvailableCloudBoxCount" : 3,
      "AssociatedCenOwnerId" : 1688000000000000,
      "AssociatedCenId" : "cen-ol0xptl3edqc8i****",
      "AssociatedCloudBoxCount" : 3,
      "Name" : "zxtest-OSS"
    }, {
      "IsDefault" : false,
      "InterworkingStatus" : "enable",
      "ResourceGroupId" : "rg-acfm2iu4fnc****",
      "CreateTime" : 1589866291000,
      "CcnId" : "ccn-wf0kz6wohe03h2****",
      "AvailableCloudBoxCount" : 1,
      "AssociatedCenOwnerId" : 1688000000000000,
      "CidrBlock" : "192.168.10.0/24",
      "AssociatedCenId" : "cen-8z69wtwqel33lq****",
      "AssociatedCloudBoxCount" : 1,
      "Name" : "zxtest"
    } ]
  },
  "TotalCount" : 3,
  "PageSize" : 10,
  "RequestId" : "7DA93FE9-D008-49FB-8D9B-186F509EA307",
  "PageNumber" : 1
}

Error codes

HttpCode Error code Error message Description
400 InvalidTagKey The specified tag key is invalid. The error message returned because the tag key is invalid.
400 InvalidTagValue The specified tag value is invalid. The error message returned because the tag value is invalid.
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. The error message returned because the number of tags exceeds the upper limit.
400 SizeLimitExceeded.ResourceId The maximum number of resource IDs is exceeded. The error message returned because the number of resource IDs exceeds the upper limit.
400 Forbidden.TagKey.Duplicated The specified tag key already exists. The error message returned because a tag key value overlaps with another.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you do not have the permissions to manage the specified resource.

For a list of error codes, visit the API Error Center.