查询应用接口

读取当前组织的开放平台应用,查看应用名称、已授予的 API Scope 和人员访问范围。用于核对应用授权配置,响应不包含 API Key 明文。

所需权限

所需权限资源Scope资源服务
应用读取(读取)appsadmin.v1.apps.readqwenwork-biz-service

GET /api/openapi/v1/open-platform/apps

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET --url '<BASE_URL>/api/openapi/v1/open-platform/apps' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
itemsarray | 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_scopesarray | null应用获授的 API Scope 编码列表。["<string>"]
items[].created_atstring · date-time此记录的创建时间。"2026-08-27T10:00:00Z"
items[].created_by_namestring创建者的姓名。"<string>"
items[].descriptionstring此对象的说明,用于补充名称之外的信息。"<string>"
items[].idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
items[].modified_atstring · date-time此记录最后一次修改的时间。"2026-08-27T10:00:00Z"
items[].modified_by_namestring最后修改者的姓名。"<string>"
items[].namestring用于识别此对象的名称。"<string>"
items[].statusstring此记录当前所处的状态。"<string>"
items[].subject_scopeany应用允许访问的用户范围配置。"<string>"
{
  "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 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}