文档

CreateSmartAccessGatewayClientUser - 创建用户

更新时间:

调用CreateSmartAccessGatewayClientUser创建用户。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:CreateSmartAccessGatewayClientUserWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-shanghai
SmartAGIdstring

智能接入网关 App 实例 ID。

sag-gnhe6sywtare5****
UserNamestring

用户名,同一个智能接入网关 App 实例下的用户名不可以重复。 名称长度为 7~33 个字符,必须以大小写字母或数字开头,可以包含下划线(_) 、at(@)、半角句号(.)和短划线(-)。

说明 用户名和密码相互依赖,若指定用户名则必须指定密码,反之,若指定密码则必须指定用户名。
doctest
ClientIpstring
  • 如果开启客户端 App 服务,需要设置 App 的 IP 地址。当前账号始终保持以选择的 IP 地址接入。
说明 设置 App 的 IP 地址必须在私网网段内。
  • 如果关闭客户端 App 服务,系统自动从私网网段内分配可用 IP 地址,每次重连 IP 地址都会重新分配。
10.0.XX.XX
UserMailstring

普通用户的邮箱地址,用于管理员向普通用户发送登录 App 的账号信息。

username@example.com
Bandwidthlong

带宽峰值。单位:Kbps。取值范围:1 Kbps~20000 Kbps。默认值:2000 Kbps

20
Passwordstring

登录智能接入网关 App 的密码。

密码命名规则: 8~32 位字符,以(A-Za-z0-9)开头,可包含数字、英文大小写、下划线(_)、at(@)、短划线(-)。

duuf****

返回参数

名称类型描述示例值
object
UserNamestring

用户名。

doc
RequestIdstring

请求 ID。

72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7
UserMailstring

普通用户的邮箱地址。

username@example.com
Bandwidthinteger

带宽峰值。单位:Kbps。

20
ClientIpstring

客户端 App 的 IP 地址。

10.0.XX.XX

示例

正常返回示例

JSON格式

{
  "UserName": "doc",
  "RequestId": "72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7",
  "UserMail": "username@example.com",
  "Bandwidth": 20,
  "ClientIp": "10.0.XX.XX"
}

错误码

HTTP status code错误码错误信息描述
400ClientUser.BandwidthInvalidThe specified Bandwidth is invalid.用户带宽非法。
400ClientUser.EmailEmptyYou must specify UserEmail.用户邮箱不能为空。
400ClientUser.EmailInvalidThe format of the specified UserEmail is invalid.用户邮箱格式非法。
400ClientUser.InvalidClientIpThe specified ClientIp is invalid.非法的用户IP
400ClientUser.IpEmptyYou must specify ClientIp.未指定静态IP。
400ClientUser.IpInvalidThe specified ClientIp is invalid.指定的静态IP非法。
400ClientUser.NameEmptyYou must specify UserName.用户名不能为空。
400ClientUser.NameInvalidThe specified UserName is invalid.用户名格式非法。
400ClientUser.UserExistThe specified user already exists.用户已经存在。
400ClientUser.UserOverLimitThe maximum number of users is exceeded. 用户数已超限
400SAG.CidrEmptyYou must specify the CIDR blocks of SAG.智能网关地址段为空。
400ClientUser.PasswordInvalidThe specified password format is invalid.密码格式非法。

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