DescribeCloudConnectNetworks API for querying Cloud Connect Network instances - Smart Access Gateway

Retrieves Cloud Connect Network (CCN) instances in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DescribeCloudConnectNetworks

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the CCN is located.	cn-shanghai
Name	string	No	The name of the CCN. The name must be 2 to 100 characters long, start with a letter or a Chinese character, and can contain digits, underscores (_), periods (.), and hyphens (-).	ccnname
CcnId	string	No	The ID of the CCN.	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 page number. Default value: 1.	1
Tag	array<object>	No	The tags to filter CCN instances.	DescribeCloudConnectNetworks
	object	No	A tag, which consists of a key-value pair.
Key	string	No	The tag key.	test
Value	string	No	The tag value.	test

Response elements

Element	Type	Description	Example
	object	The query result.
CloudConnectNetworks	object
CloudConnectNetwork	array<object>	A list of CCN instances.
	array<object>	The details of the CCN instance.
CreateTime	integer	The timestamp that indicates when the CCN instance was created.	1523618639000
AssociatedCenOwnerId	string	The account ID of the associated Cloud Enterprise Network (CEN) instance.	168800000000****
AssociatedCloudBoxCount	string	The number of Smart Access Gateway (SAG) instances bound to the Cloud Connect Network instance.	1
Tags	object
Tag	array<object>	The tags that are attached to the instance.
	object	The details of a tag.
Key	string	The key of the tag.	test
Value	string	The value of the tag.	test
InterworkingStatus	string	Specifies whether interworking is enabled among SAG instances that are bound to the same CCN instance. enable: Interworking is enabled. disable: Interworking is disabled.	enable
CcnId	string	The ID of the Cloud Connect Network instance.	ccn-l9340rlu5enst******
AvailableCloudBoxCount	string	The number of bound SAG instances that are in the available state.	1
CidrBlock	string	The CIDR block of the instance.	10.10.10.0/24
Description	string	The description of the CCN instance.	ccndesc
SnatCidrBlock	string	The source network address translation (SNAT) CIDR block.	10.10.10.0/25
AssociatedCenId	string	The ID of the bound CEN instance.	cen-0jtu0bcbika5b5****
Name	string	The name of the CEN instance.	ccnname
ResourceGroupId	string	The ID of the resource group to which the Cloud Connect Network instance belongs.	rg-acfm2iu4fnc****
NewAgw	boolean	Specifies whether the CCN instance supports new AGWs.	true
Subnet	string	The subnet used for interworking between the CCN and CEN.	192.168.20.0/24
TotalCount	integer	The total number of entries that match the query.	3
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	3F2A0B80-D6D1-4764-8D77-38067DBBA345
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "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****",
        "NewAgw": true,
        "Subnet": "192.168.20.0/24"
      }
    ]
  },
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.