实现智能接入网关App客户端漫游,客户端可跨区域访问内网。
接口说明
在调用RoamClientUser
接口前,建议您先了解智能接入网关 App 漫游功能及其说明。更多信息,请参见配置客户端漫游。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smartag:RoamClientUser | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 目的智能接入网关 App 实例所在的地域 ID。 | cn-shanghai |
OriginSmartAGId | string | 是 | 源智能接入网关 App 实例 ID。 | sag-m9uhqekwnqcnyy**** |
TargetSmartAGId | string | 是 | 目的智能接入网关 App 实例 ID。 | sag-ghwa10ko6ndwug**** |
OriginRegionId | string | 是 | 源智能接入网关 App 实例所在的地域 ID。 | ap-southeast-1 |
UserName | string | 是 | 要漫游的客户端账号的用户名。 | nametest |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "3200E8A3-563F-4FFC-8BDB-0F1263FA69E8"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能接入网关实例不存在。 |
400 | ClientUser.NotSupportAction | You cannot create a user in the current SAG instance. | 当前智能网关实例不支持创建客户端用户。 |
400 | SAG.CidrEmpty | You must specify the CIDR blocks of SAG. | 智能网关地址段为空。 |
400 | ClientUser.BandwidthInvalid | The specified Bandwidth is invalid. | 用户带宽非法。 |
400 | ClientUser.InvalidClientIp | The specified ClientIp is invalid. | 非法的用户IP |
400 | ClientUser.UserOverLimit | The maximum number of users is exceeded. | 用户数已超限 |
400 | ClientUser.UserExist | The specified user already exists. | 用户已经存在。 |
400 | ClientUser.NameInvalid | The specified UserName is invalid. | 用户名格式非法。 |
400 | SAG.CidrOverlap | 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. | 两个SAG实例绑定企业码不一致。 |
访问错误中心查看更多错误码。