根据用户组名称关键字搜索用户组信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Keyword | string | 是 | 用户组名称关键字。 | 测试用户组 |
返回参数
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5",
"Result": [
{
"IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****",
"ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
"ModifiedTime": "2021-03-15 20:36:40",
"CreateUser": "46e5374665ba4b679ee22e2a2927****",
"UsergroupName": "测试用户组01",
"CreateTime": "2021-03-15 17:13:55",
"UsergroupDesc": "测试描述",
"UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
"ModifyUser": "46e5374665ba4b679ee22e2a2927****"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | 没有权限，您不是组织管理员。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。 |
| 400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限，您不是该群空间的管理员。 |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
| 400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
访问错误中心查看更多错误码。