接口请求域名： bi.intl.tencentcloudapi.com 。
用户角色列表
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserRoleList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PageNo | 是 | Integer | 页码 |
| PageSize | 是 | Integer | 页数 |
| AllPage | 否 | Boolean | 全部页码 |
| UserType | 否 | String | 0 企业用户 1 访客 不填表示所有用户 |
| Keyword | 否 | String | 模糊搜索的关键字 |
| ProjectId | 否 | String | 项目id |
| IsOnlyBindAppUser | 否 | Boolean | 是否只获取绑定企微应用的 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 扩展描述信息(提供更多异常信息,用于辅助判断) 注意：此字段可能返回 null，表示取不到有效值。 |
| Data | UserRoleListData | 数据 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 消息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
用户信息列表
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserRoleList
<公共请求参数>
{
"PageNo": 1982493789748932,
"PageSize": 1982493789748932,
"AllPage": false,
"UserType": "UserType",
"Keyword": "Keyword",
"ProjectId": "ProjectId",
"IsOnlyBindAppUser": false
}
{
"Response": {
"ErrorInfo": {
"ErrorTip": "",
"ErrorLevel": "INFO",
"DocLink": "",
"FAQ": "",
"ReservedField": ""
},
"Extra": "",
"Data": {
"Total": 0,
"TotalPages": 0,
"List": [
{
"Id": 1,
"RoleList": [
{
"RoleName": "企业管理员",
"RoleId": 0,
"ProjectId": 0,
"ProjectName": "测试项目",
"ScopeType": 0,
"ModuleCollection": "datasource"
}
],
"RoleIdList": [
1
],
"UserId": "10210",
"UserName": "zhangsan",
"CorpId": "30310",
"Email": "123***@qq.com",
"CreatedUser": "zhangsan",
"CreatedAt": "2020-09-22 00:00:00",
"UpdatedUser": "zhangsan",
"UpdatedAt": "2020-09-22 00:00:00",
"LastLogin": "2020-09-22T00:00:00+00:00",
"Status": 0,
"PhoneNumber": "86312***212",
"AreaCode": "086",
"RootAccount": true,
"CorpAdmin": true,
"AppUserId": "2102",
"AppUserAliasName": "zhangsan",
"AppUserName": "zhangsan",
"InValidateAppRange": true
}
]
},
"Msg": "成功",
"RequestId": ""
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.Internal | 内部错误。 |
| MissingParameter.MissingParam | 必填参数缺失。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnauthorizedOperation.Inactive | 用户未启用。 |
| UnauthorizedOperation.UserNotExist | 用户不存在。 |
| UnsupportedOperation.BIError | 默认业务异常。 |
文档反馈