Use the CreateCloudConnectNetwork API to create a Cloud Connect Network - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Operation description

A Cloud Connect Network (CCN) is a device access matrix that consists of Alibaba Cloud distributed access gateways. CCN is another important component of Smart Access Gateway. After you attach Smart Access Gateway to a CCN, Smart Access Gateway can connect your on-premises network to Alibaba Cloud through the CCN via network connectivity. For more information, see Cloud Connect Network overview.

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:CreateCloudConnectNetwork

create

*CloudConnectNetwork

acs:smartag:{#regionId}:{#accountId}:ccn/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Cloud Connect Network (CCN) instance.	cn-shanghai
Name	string	No	The name of the Cloud Connect Network (CCN) instance. The name must be 2 to 100 characters in length and must start with a letter or a Chinese character. It can contain digits, underscores (_), periods (.), and hyphens (-).	ccnname
Description	string	No	The description of the Cloud Connect Network (CCN) instance. The description must be 2 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, underscores (_), and hyphens (-).	ccndesc
CidrBlock	string	No	The private CIDR block.	172.XX.XX.0/24
SnatCidrBlock	string	No	The SNAT private CIDR block.	172.XX.XX.0/25

Response elements

Element	Type	Description	Example
	object	The Cloud Connect Network (CCN) instance information.
Status	string	The instance status of the Cloud Connect Network (CCN). Valid values: Active: Normal. Pending: Pending creation.	Active
Description	string	The description of the Cloud Connect Network (CCN) instance.	ccndesc
RequestId	string	The request ID.	C48E8EB2-37A4-495B-A95C-29CA1FD26C82
CcnId	string	The instance ID of the Cloud Connect Network (CCN).	ccn-l9340rlu5ens*****
CidrBlock	string	The private CIDR block.	172.XX.XX.0/24
SnatCidrBlock	string	The SNAT private CIDR block.	172.XX.XX.0/25
Name	string	The name of the Cloud Connect Network (CCN) instance.	ccnname
ResourceGroupId	string	The ID of the resource group to which the Cloud Connect Network (CCN) instance belongs.	rg-acfm2iu4fnc****

Examples

Success response

JSON format

{
  "Status": "Active",
  "Description": "ccndesc",
  "RequestId": "C48E8EB2-37A4-495B-A95C-29CA1FD26C82",
  "CcnId": "ccn-l9340rlu5ens*****",
  "CidrBlock": "172.XX.XX.0/24",
  "SnatCidrBlock": "172.XX.XX.0/25",
  "Name": "ccnname",
  "ResourceGroupId": "rg-acfm2iu4fnc****"
}

Error response

JSON format

{
  "Name": "DocTest",
  "Status": "Active",
  "RequestId": "F0C4D78D-C60E-4A3B-A652-3A2835305C0B",
  "CcnId": "ccn-l9340rlu5enstmzj5i"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CCN.CidrAmountLimit	The maximum number of CCN CIDR blocks is exceeded.	The maximum number of CCN CIDR blocks is exceeded.
400	CCN.CidrEmpty	You must specify the CCN CIDR block.	You must specify the CCN CIDR block.
400	CCN.InvalidCidr	The specified CCN CIDR block is invalid.	The specified CCN CIDR block is invalid.
400	CCN.InvalidSnatCidr	The SNAT CIDR block of CCN is invalid.	The SNAT CIDR block of CCN is invalid.
400	CCN.SnatCidrConflict	The specified SNAT CIDR block is invalid.	The specified SNAT CIDR block is invalid.
403	InvalidDescription	Description not valid.	The length of the description has exceeded the upper limit.
403	InvalidName	Name not valid.	The specified name is invalid.
403	CcnAmountLimit	The CCNs you created has reached the limit, you can raise the limit by application.	The number of CCN instances that you have created has reached the upper limit. You can submit a ticket to request a quota increase.
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.