千问办公官方帮助中心(阿里云)
读取当前组织的开放平台应用,查看应用名称、已授予的 API Scope 和人员访问范围。用于核对应用授权配置,响应不包含 API Key 明文。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
| 应用读取(读取) | apps | admin.v1.apps.read | qwenwork-biz-service |
HELPCODEESCAPE-http
GET /api/openapi/v1/open-platform/apps认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\*\*\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
此接口没有额外请求参数。
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
HELPCODEESCAPE-text
curl --request GET \
--url '<BASE_URL>/api/openapi/v1/open-platform/apps' \
--header 'Authorization: Bearer <API_KEY>'响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
| items | array \| null | 是 | 符合查询条件的当前页记录列表。 | \[\{"api_scopes":\["\<string\>"\],"created_at":"2026-08-27T10:00:00Z","created_by_name":"\<string\>","description":"\<string\>","id":"\<string\>","modified_at":"2026-08-27T10:00:00Z","modified_by_name":"\<string\>","name":"\<string\>","status":"\<string\>","subject_scope":"\<string\>"\}\] |
| items\[\].api_scopes | array \| null | 是 | 应用获授的 API Scope 编码列表。 | \["\<string\>"\] |
| items\[\].created_at | string · date-time | 是 | 此记录的创建时间。 | "2026-08-27T10:00:00Z" |
| items\[\].created_by_name | string | 是 | 创建者的姓名。 | "\<string\>" |
| items\[\].description | string | 是 | 此对象的说明,用于补充名称之外的信息。 | "\<string\>" |
| items\[\].id | string | 是 | 此记录的唯一标识,查询、更新或删除对应记录时使用。 | "\<string\>" |
| items\[\].modified_at | string · date-time | 是 | 此记录最后一次修改的时间。 | "2026-08-27T10:00:00Z" |
| items\[\].modified_by_name | string | 是 | 最后修改者的姓名。 | "\<string\>" |
| items\[\].name | string | 是 | 用于识别此对象的名称。 | "\<string\>" |
| items\[\].status | string | 是 | 此记录当前所处的状态。 | "\<string\>" |
| items\[\].subject_scope | any | 是 | 应用允许访问的用户范围配置。 | "\<string\>" |
HELPCODEESCAPE-json
{
"items": [
{
"api_scopes": [
"<string>"
],
"created_at": "2026-08-27T10:00:00Z",
"created_by_name": "<string>",
"description": "<string>",
"id": "<string>",
"modified_at": "2026-08-27T10:00:00Z",
"modified_by_name": "<string>",
"name": "<string>",
"status": "<string>",
"subject_scope": "<string>"
}
]
}default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "\<string\>" |
| detail | string | 是 | 便于阅读的错误说明。 | "\<string\>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | \{"field":"\<string\>","reason":"\<string\>","suggestion":"\<string\>"\} |
| details.field | string | 否 | 未通过校验的请求字段。 | "\<string\>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "\<string\>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "\<string\>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "\<string\>" |
HELPCODEESCAPE-json
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}