全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网

用户管理API

更新时间:2017-08-25 16:10:22

AddUsers 批量新增用户账号

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:AddUsers
RegionId String - 地域ID
ClusterId String - 集群ID
User.n.Name String - 第n个(n从1开始编号,可以有多条)新增账户的用户名。6-30位大小写英文字母数字或者英文符号”.”,必须英文开头。
User.n.Group String - 第n个(n从1开始编号,可以有多条)新增账户的用户组,目前仅能使用‘users’和‘wheel’两个组,‘wheel’是sudo权限用户组。
User.n.Password String - 第n个(n从1开始编号,可以有多条)新增账户的密码。8-30个字符,必须同时包含三项(大、小写字母,数字和特殊符号)。支持以下特殊字符:( ) ` ~ ! @ # $ % ^ & * - + = \ { } [ ] : ; ‘ < > , . ? / 请务必使用HTTPS协议调用API以避免可能发生的密码泄露。

返回参数

公共返回参数。

错误码

Code 解释
InvalidParams 无效的参数
UsernameExist 用户名已经存在
UnknownError 未知错误

DeleteUsers 批量删除用户账号

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:DeleteUsers
RegionId String - 地域ID
ClusterId String - 集群ID
User.n.Name String - 第n个(n从1开始编号,可以有多条)要删除的账号的用户名。

注意:用户home目录下的文件不删除。

返回参数

公共返回参数。

错误码

Code 解释
InvalidParams 无效的参数
UsernameNotExist 用户名不存在
UnknownError 未知错误

ListUsers 查询用户列表

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:ListUsers 。
RegionId String - 地域ID
ClusterId String - 集群ID
PageNumber Integer 1 显示的页码,起始值为 1 。
PageSize Integer 10 每页显示的条数,1-50 。

返回参数

公共返回参数和以下字段:

字段 类型 描述
Users Array\ 用户账户数组
TotalCount Integer 列表条目总数
PageNumber Integer 当前页码
PageSize Integer 本页条数

其中,UserInfo字段中每个元素包含以下字段:

字段 类型 描述
Name String 用户名
Group String 用户权限组,目前可选’users’和’wheel’2种用户组,’users’组用户具有普通权限,’wheel’组用户具有sudo权限。
AddTime String 添加用户的时间

错误码

Code 解释
InvalidParams 无效的参数
UnknownError 未知错误

ModifyUserGroups 批量修改用户权限组

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:ModifyUserGroups
RegionId String - 地域ID
ClusterId String - 集群ID
Users String - JSON格式字符串,包含修改的用户信息数组,例如 ‘[{“Username”:”somename1”,”Group”:”users”},{“Username”:”somename2”,”Group”:”wheel”}]’
User.n.Name String - 第n个(n从1开始编号,可以有多条)要修改账户的用户名。
User.n.Group String - 第n个(n从1开始编号,可以有多条)要修改账户的用户组,目前仅能使用‘users’和‘wheel’两个组,‘wheel’是sudo权限用户组。

返回参数

公共返回参数。

错误码

Code 解释
InvalidParams 无效的参数
UsernameNotExist 用户名不存在
UnknownError 未知错误

ModifyUserPasswords 批量修改用户密码

请求参数

字段 类型 是否必须 默认值 描述
Action String - 操作接口名,系统规定参数,取值:ModifyUserPasswords
RegionId String - 地域ID
ClusterId String - 集群ID
User.n.Name String - 第n个(n从1开始编号,可以有多条)要修改账户的用户名。
User.n.Password String - 第n个(n从1开始编号,可以有多条)要修改账户的新密码。8-30个字符,必须同时包含三项(大、小写字母,数字和特殊符号)。支持以下特殊字符:( ) ` ~ ! @ # $ % ^ & * - + = \ { } [ ] : ; ‘ < > , . ? / 请务必使用HTTPS协议调用API以避免可能发生的密码泄露。

返回参数

公共返回参数。

错误码

Code 解释
InvalidParams 无效的参数
UsernameNotExist 用户名不存在
UnknownError 未知错误
本文导读目录