Grant SAG Instance Access to Cross-Account CCN - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

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

*CloudConnectNetwork

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

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-tzirqx07bvcngm****
CcnInstanceId	string	Yes	The ID of the CCN instance.	ccn-n2935s1mnwv8i*****
CcnUid	integer	Yes	The ID of the Alibaba Cloud account to which the CCN instance belongs.	1210123456123456
GrantTrafficService	boolean	No	Whether to grant the CCN instance permissions to manage network traffic from the SAG instance. After the permissions are granted, the CCN instance can redirect Internet-bound traffic from the SAG instance to Cloud Security Access Service (CSAS) for security audit. true: grants permissions. false: does not grant permissions. Note If this parameter is set to true and the SAG instance connected to the CCN instance has secure rerouting enabled, the permissions cannot be revoked.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	6E1674AC-083C-4031-B047-7A66E418E0C6
InstanceId	string	The ID of the permission policy.	sgc-6z21oj0vjjrx6s****

Examples

Success response

JSON format

{
  "RequestId": "6E1674AC-083C-4031-B047-7A66E418E0C6",
  "InstanceId": "sgc-6z21oj0vjjrx6s****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CCN.InvalidUid	The specified CCN user ID is invalid.	The specified CCN user ID is invalid.
400	CCN.InvalidId	You must specify the CCN instance ID.	You must specify the CCN instance ID.
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	SAG.GrantDuplicated	You have authorized another CCN instance to bind to the specified SAG instance. Revoke the authorization first.	You have authorized another CCN instance to bind to the specified SAG instance. Revoke the authorization first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.