Use BindSmartAccessGateway to associate a Smart Access Gateway instance with a Cloud Connect Network instance - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Binds a Smart Access Gateway to a specified Cloud Connect Network (CCN).

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

*CloudConnectNetwork

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

None

Request parameters

Parameter	Type	Required	Description	Example
CcnId	string	Yes	The ID of the Cloud Connect Network (CCN) to bind.	ccn-isdjvvkexkrpk*****
SmartAGId	string	Yes	The ID of the Smart Access Gateway.	sag-m7ez44zpayma*****
RegionId	string	No	The region ID of the Smart Access Gateway.	cn-hangzhou
SmartAGUid	integer	No	The user ID of the Smart Access Gateway instance.	1250123456123456

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8A3FF8DD-B27D-4ED2-B032-5EF90B38195D

Examples

Success response

JSON format

{
  "RequestId": "8A3FF8DD-B27D-4ED2-B032-5EF90B38195D"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.NoBindSN	The specified SAG is not bound with a serial number. Please perform binding first.	The specified SAG is not bound with a serial number. Please perform binding first.
400	SAG.NoBandwidth	Buy bandwidth for the specified SAG instance before binding it to a CCN instance.	Buy bandwidth for the specified SAG instance before binding it to a CCN instance.
400	NotBoundCEN	Bind the specified CCN instance to a CEN instance first.	Bind the specified CCN instance to a CEN instance first.
400	SAG.VbrNotBondCen	Bind the specified VBR instance to a CEN instance first.	Bind the specified VBR instance to a CEN instance first.
400	AlreadyBound.CCN	The specified SAG instance is bound to another CCN instance. Unbind them first.	The specified SAG instance is associated with another CCN instance. Disassociate them first.
400	LinkLevelBackupExists	The specified SAG instance is already used as a leased line backup.	The specified SAG instance is already used as a leased line backup.
400	TunnelIdDistributeError	Tunnel id distribute error.
400	UpdateError.SMARTAG	Update smart access gateway error.
400	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.	The specified Smart Access Gateway has expired.
400	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.	The specified SAG instance is inactive. You must activate the instance first.
400	CcnNotSupportNewAgw	The specified cloud connect network does not support this operation.	CCN does not support this operation. Please refresh the page and try again.
400	UnBinding	The specified instance id unbinding.	The Smart Access Gateway instance is being unbound. Please try again later.
403	CidrConflict	Cidr is conflict, Please Check your input.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidId.CCN	Invalid cloud connect network id.	The ID of the CCN instance is invalid.
403	InvalidId.SMARTAG	The specified smart access gateway instance id is invalid.	The SAG instance ID is invalid.
403	SmartAccessGatewayAlreadyBound	The smart access gateway already bound.	The SAG instance has already been associated with a CCN instance.
403	TunnelIdNotEnough	Tunnel id is not enough.	Tunnel IDs are insufficient.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.
403	VbrConflict.ChangeSubnet	The subnet of the gateway conflicts with the VBR. Modify the subnet first.	The subnet CIDR block of the SAG instance is in conflict with the VBR. You must change the subnet CIDR block.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.