调用RoamClientUser接口允许智能接入网关App实例下客户端漫游,实现客户端可跨区域访问内网。

使用说明

在调用RoamClientUser接口前,建议您先了解智能接入网关App漫游功能及其说明。更多信息,请参见配置客户端漫游

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RoamClientUser

系统规定参数。取值:RoamClientUser

RegionId String cn-shanghai

目的智能接入网关App实例所在的地域ID。

OriginSmartAGId String sag-m9uhqekwnqcnyy****

源智能接入网关App实例ID。

TargetSmartAGId String sag-ghwa10ko6ndwug****

目的智能接入网关App实例ID。

OriginRegionId String ap-southeast-2

源智能接入网关App实例所在的地域ID。

UserName String nametest

要漫游的客户端账号的用户名。

返回数据

名称 类型 示例值 描述
RequestId String 3200E8A3-563F-4FFC-8BDB-0F1263FA69E8

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RoamClientUser
&RegionId=cn-shanghai
&OriginSmartAGId=sag-m9uhqekwnqcnyy****
&TargetSmartAGId=sag-ghwa10ko6ndwug****
&OriginRegionId=ap-southeast-2
&UserName=nametest
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RoamClientUserResponse>
    <RequestId>3200E8A3-563F-4FFC-8BDB-0F1263FA69E8</RequestId>
</RoamClientUserResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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实例绑定企业码不一致。

访问错误中心查看更多错误码。