查看应用基本信息
获取企业下应用基本信息,如应用名称 、应用命名空间等。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/apaas/v1/apps |
| HTTP Method | GET |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | app_engine:apps:read 查询应用基本信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | string | 否 | 分页大小,必填,范围:【0,50】 示例值:10 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | app\[\] | 应用基本信息列表 |
└ name | i18n\[\] | aPaaS 产品应用的名称 |
└ language_code | string | 语种 |
└ text | string | 文本 |
└ namespace | string | aPaaS 产品应用的命名空间 |
└ created_at | int | aPaaS 产品应用的创建时间 |
└ creator | int | aPaaS 产品应用的创建者 |
└ owner | int | aPaaS 产品应用的所有者 |
└ status | string | aPaaS 产品应用的状态 可选值有: - pending_launch: 应用待发布 - enabled: 应用已发布 - disabled: 应用已停用 - stopped: 应用已停服 - unspecified: 应用状态未确定 |
└ app_roles_info | app_roles_info | aPaaS 产品应用的成员管理信息 |
└ admins | int\[\] | aPaaS 产品应用管理员的 ID |
└ developers | int\[\] | aPaaS 产品应用开发者的 ID |
└ test_users | int\[\] | aPaaS 产品应用测试人员的 ID |
└ data_admins | int\[\] | aPaaS 产品应用数据管理员的 ID |
└ icon | string | aPaaS 产品应用的图标 |
└ description | i18n\[\] | aPaaS 产品应用的描述 |
└ language_code | string | 语种 |
└ text | string | 文本 |
└ type | string | aPaaS 产品应用的类型 可选值有: - custom: 自建应用 - client_isv_saas: 来自服务商的 SaaS 应用 - client_isv_project: 来自服务商的项目制应用 |
└ enable_status | string | aPaaS 产品应用的启用状态 可选值有: - enabled: 启用 - disabled: 停用 |
└ release_status | string | aPaaS 产品应用的发布状态 可选值有: - released: 已发布 - unreleased: 未发布 |
└ service_status | string | aPaaS 产品应用的服务状态 可选值有: - available: 可用 - unavailable: 不可用 |
└ service_unavailable_reason | string | aPaaS 产品应用的停服原因 可选值有: - from_isv: ISV服务商停服 - entitlement_expire: 企业权益到期停服 |
└ feature_set | string | aPaaS 产品应用的版本 可选值有: - paid: 付费版 - free: 免费版 |
└ charge_mode | string | aPaaS 产品应用的计费方式 可选值有: - per_user_per_app: 应用席位计费 - per_user: 不限应用席位计费 - independent: 独立计费 - free: 免费 |
└ isv_tenant | client_isv_tenant | aPaaS 产品应用的服务商信息 |
└ id | string | 服务商ID |
└ name | string | 服务商名称 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"name": [
{
"language_code": "2052",
"text": "测试应用"
}
],
"namespace": "package_35f605__c",
"created_at": 1736480945563,
"creator": 1818624575806604,
"owner": 1818624575806604,
"status": "enabled",
"app_roles_info": {
"admins": [
1803710089388154
],
"developers": [
1803710089388154
],
"test_users": [
1803710089388154
],
"data_admins": [
1803710089388154
]
},
"icon": "https://ae.feishu.cn/img/namespaces/_global/download/namespace_8aed421832fa4586968596f70e6eaebd_p.jpg",
"description": [
{
"language_code": "2052",
"text": "测试应用描述"
}
],
"type": "custom",
"enable_status": "enabled",
"release_status": "released",
"service_status": "available",
"service_unavailable_reason": "entitlement_expire",
"feature_set": "paid",
"charge_mode": "per_user_per_app",
"isv_tenant": {
"id": "798456",
"name": "北京飞书科技有限公司"
}
}
],
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 2320002 | internal error | 内部错误,请稍后重试,仍然出现可以咨询客服 |
| 404 | 2320003 | tenant does not exist | 请自查企业是否可用 |
| 404 | 2320004 | user does not exist | 请自查用户是否存在 |
| 403 | 2320005 | insufficient permissions | 请自查用户是否具备权限 |
| 400 | 2320006 | bad request or invalid parameter | 请自查请求方法、请求信息、请求数据格式等是正确的 |
