Skip to content

当前密钥范围

查看当前密钥范围

GET /openapi/v1/scopes/

使用 Bearer 访问密钥查询该密钥的有效期、已配置的功能权限和允许访问的工作区。可在调用业务接口前使用此接口核验当前密钥的实际授权范围。

此接口只支持 Bearer 访问密钥鉴权;使用 JWT 调用时会返回错误。响应中不会返回密钥值。

请求头

Authorization: Bearer <access_token>

返回结果

{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "数据同步服务",
    "desc": "供数据同步任务调用",
    "expired_at": "2026-12-31T23:59:59+08:00",
    "permissions": ["workspace", "data"],
    "workspaces": [
      {
        "id": 1,
        "name": "销售分析",
        "desc": "销售数据工作区"
      }
    ]
  }
}

参数说明

参数 类型 说明
data.id string 访问密钥 ID
data.name string 访问密钥名称
data.desc string 访问密钥描述
data.expired_at string / null 访问密钥过期时间;null 表示未设置过期时间
data.permissions array 已配置的功能权限;空数组表示不限制功能权限
data.permissions[] string 功能权限:auth(登录)、account(用户管理)、workspace(工作区管理)、data(数据查询)、task(异步任务管理)、embed(向量服务)
data.workspaces array 允许访问的工作区列表
data.workspaces[].id int 工作区 ID
data.workspaces[].name string 工作区名称
data.workspaces[].desc string 工作区描述

若密钥未限制可访问的工作区,data.workspaces 会返回全部工作区;若配置了工作区范围,则仅返回被允许访问的工作区。