DescribeCloudConnectNetworks - Smart Access Gateway - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeCloudConnectNetworks	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the CCN instances are deployed.	cn-shanghai
Name	string	No	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.	ccnname
CcnId	string	No	The ID of the CCN instance.	ccn-l9340rlu5enst*****
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 50.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
Tag	object []	No
Key	string	No	The key of the tag that is bound to the CCN instance.	test
Value	string	No	The value of the tag that is bound to the CCN instance.	test

Response parameters

Parameter	Type	Description	Example
	object
CloudConnectNetworks	object []	The list of CCN instances.
CreateTime	long	The timestamp when the CCN instance was created.	1523618639000
AssociatedCenOwnerId	string	The account ID of the Cloud Enterprise Network (CEN) instance to which the CCN instance is attached.	168800000000****
AssociatedCloudBoxCount	string	The number of Smart Access Gateway (SAG) instances that are associated with the CCN instance.	1
Tags	object []	The list of tags.
Key	string	The key of the tag that is bound to the CCN instance.	test
Value	string	The value of the tag that is bound to the CCN instance.	test
InterworkingStatus	string	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.	enable
CcnId	string	The ID of the CCN instance.	ccn-l9340rlu5enst******
AvailableCloudBoxCount	string	The number of SAG instances in the Available state that are associated with the CCN instance.	1
CidrBlock	string	The private CIDR block.	10.10.10.0/24
Description	string	The description of the CCN instance.	ccndesc
SnatCidrBlock	string	The CIDR block that is used in Source Network Address Translation (SNAT).	10.10.10.0/25
AssociatedCenId	string	The ID of the CEN instance to which the CCN instance is attached.	cen-0jtu0bcbika5b5****
Name	string	The name of the CCN instance.	ccnname
ResourceGroupId	string	The ID of the resource group to which the CCN instance belongs.	rg-acfm2iu4fnc****
TotalCount	integer	The total number of the CCN instances.	3
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	3F2A0B80-D6D1-4764-8D77-38067DBBA345
PageNumber	integer	The page number of the returned page.	1

Examples

Sample success responses

JSONformat

{
  "CloudConnectNetworks": {
    "CloudConnectNetwork": [
      {
        "CreateTime": 1523618639000,
        "AssociatedCenOwnerId": "168800000000****",
        "AssociatedCloudBoxCount": "1",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "InterworkingStatus": "enable",
        "CcnId": "ccn-l9340rlu5enst******",
        "AvailableCloudBoxCount": "1",
        "CidrBlock": "10.10.10.0/24",
        "Description": "ccndesc",
        "SnatCidrBlock": "10.10.10.0/25",
        "AssociatedCenId": "cen-0jtu0bcbika5b5****",
        "Name": "ccnname",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  },
  "TotalCount": 3,
  "PageSize": 10,
  "RequestId": "3F2A0B80-D6D1-4764-8D77-38067DBBA345",
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTagKey	The specified tag key is invalid.	The tag key is invalid.
400	InvalidTagValue	The specified tag value is invalid.	The specified tag value is invalid.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The specified number of tag keys has exceeded the upper limit.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The specified number of resource IDs has exceeded the upper limit.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The specified tag key already exists.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.

For a list of error codes, visit the Service error codes.