All Products
Search
Document Center

Smart Access Gateway:RoamClientUser

Last Updated:Mar 03, 2024

Enables roaming for the client accounts of a Smart Access Gateway (SAG) app to allow clients to access the internal network 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:RoamClientUserWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the SAG app instance is deployed.

cn-shanghai
OriginSmartAGIdstringYes

The ID of the source SAG app instance.

sag-m9uhqekwnqcnyy****
TargetSmartAGIdstringYes

The ID of the destination SAG app instance.

sag-ghwa10ko6ndwug****
OriginRegionIdstringYes

The ID of the region where the source SAG app instance is deployed.

ap-southeast-2
UserNamestringYes

The usernames of the client for which you want to enable roaming.

nametest

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

3200E8A3-563F-4FFC-8BDB-0F1263FA69E8

Examples

Sample success responses

JSONformat

{
  "RequestId": "3200E8A3-563F-4FFC-8BDB-0F1263FA69E8"
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400ClientUser.NotSupportActionYou cannot create a user in the current SAG instance.You cannot create a user in the current SAG instance.
400SAG.CidrEmptyYou must specify the CIDR blocks of SAG.You must specify the CIDR blocks of SAG.
400ClientUser.BandwidthInvalidThe specified Bandwidth is invalid.The specified bandwidth is invalid.
400ClientUser.InvalidClientIpThe specified ClientIp is invalid.The specified ClientIp is invalid.
400ClientUser.UserOverLimitThe maximum number of users is exceeded.The maximum number of users is exceeded.
400ClientUser.UserExistThe specified user already exists.The specified user already exists.
400ClientUser.NameInvalidThe specified UserName is invalid.The format of the username is invalid.
400SAG.CidrOverlapThe specified CIDR overlaps with an existing CIDR.The specified CIDR overlaps with an existing CIDR.
400EnterpriseCode.ConfigDifferentThe 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.