Enables roaming for the SAG app to allow clients to access Alibaba Cloud across regions.
Operation description
Before you call RoamClientUser, we recommend that you read and understand the features and usage notes of roaming. For more information, see Configure roaming on clients.
Debugging
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 Resourcesis 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:RoamClientUser | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the SAG app instance. | cn-shanghai |
| OriginSmartAGId | string | Yes | The ID of the source SAG app instance. | sag-m9uhqekwnqcnyy**** |
| TargetSmartAGId | string | Yes | The ID of the destination SAG app instance. | sag-ghwa10ko6ndwug**** |
| OriginRegionId | string | Yes | The region ID of the SAG app instance. | ap-southeast-1 |
| UserName | string | Yes | The usernames of the client for which you want to enable roaming. | nametest |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "3200E8A3-563F-4FFC-8BDB-0F1263FA69E8"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The specified SAG instance does not exist. |
| 400 | ClientUser.NotSupportAction | You cannot create a user in the current SAG instance. | You cannot create a user in the current SAG instance. |
| 400 | SAG.CidrEmpty | You must specify the CIDR blocks of SAG. | You must specify the CIDR blocks of SAG. |
| 400 | ClientUser.BandwidthInvalid | The specified Bandwidth is invalid. | The specified bandwidth is invalid. |
| 400 | ClientUser.InvalidClientIp | The specified ClientIp is invalid. | The specified ClientIp is invalid. |
| 400 | ClientUser.UserOverLimit | The maximum number of users is exceeded. | The maximum number of users is exceeded. |
| 400 | ClientUser.UserExist | The specified user already exists. | The specified user already exists. |
| 400 | ClientUser.NameInvalid | The specified UserName is invalid. | The format of the username is invalid. |
| 400 | SAG.CidrOverlap | The specified CIDR overlaps with an existing CIDR. | The specified CIDR overlaps with an existing CIDR. |
| 400 | EnterpriseCode.ConfigDifferent | The target smart access gateway enterprise code or idaas configuration is not the same. | The two SAG instances are associated with different enterprise codes. |
For a list of error codes, visit the Service error codes.