查询席位分配详情
获取租户下平台席位和应用访问席位分配详情,如用户 ID 、应用命名空间等,需要飞书 aPaaS 系统管理员作为授权人调用当前 API 。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/apaas/v1/seat_assignments |
| HTTP Method | GET |
| 接口频率限制 | 1 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | app_engine:seat_assignments:read 查询席位分配详情 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
seat_type | string | 是 | 席位类型,枚举值:per_user、per_user_per_app 示例值:per_user 可选值有: - per_user: 平台席位 - per_user_per_app: 应用访问席位 |
page_size | string | 是 | 分页大小,范围:【0,500】 示例值:10 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | seat_assignment\[\] | 席位分配情况列表 |
└ user_id | int | aPaaS 产品用户的 ID |
└ namespace | string | aPaaS 产品应用的 namespace |
└ status | string | 席位状态,枚举值:in_use 、released 可选值有: - in_use: 席位生效中 - released: 席位已释放 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"user_id": 1803710089388154,
"namespace": "package_35f605__c",
"status": "in_use"
}
],
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 2320003 | tenant does not exist | 请自查租户是否可用 |
| 404 | 2320004 | user does not exist | 请自查用户是否存在 |
| 403 | 2320005 | insufficient permissions | 请自查用户是否具备权限 |
| 400 | 2320006 | bad request or invalid parameter | 请自查请求方法、请求信息、请求数据格式等是正确的 |
