listGroups
语法
System.listGroups( [options], [filter] )
类别
System
描述
列出用户组的信息
参数
参数名 | 参数类型 | 默认值 | 描述 | 是否必填 |
---|---|---|---|---|
options | JSON | 默认不显示详细信息 | 显示模式 | 否 |
filter | JSON | 默认显示所有用户组 | 筛选条件 | 否 |
options 参数详细说明如下:
属性 | 值类型 | 是否 必填 | 格式 | 描述 |
---|---|---|---|---|
detail | Bool | 否 | { detail: true } | 是否显示详细信息 |
Note:
filter 参数支持对结果中的某些字段进行 and 、 or 、not 和精确匹配计算,对结果集进行筛选。
返回值
返回用户组的信息。
错误
如果出错则抛异常,并输出错误信息,可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。 关于错误处理可以参考常见错误处理指南。
常见错误可参考错误码。
示例
列出所有用户组的信息;
> System.listGroups()
{
"name": "sequoiadb"
}
{
"name": "lpadmin"
}
{
"name": "sambashare"
}
{
"name": "sdbadmin_group"
}
...
对结果进行筛选:
> System.listGroups( { detail: true }, { "name": "sequoiadb" } )
{
"name": "sequoiadb",
"gid": "1000",
"members": ""
}