Token
获取 Token 所在的模型信息¶
本接口在 v25.10 版本中引入
POST /openapi/v1/workspaces/{workspaceId}/tokens/models/
请求值
{
"prop": "某个 Token 的标签"
}
返回值
{
"errcode": 200,
"errmsg": "success",
"data": [
{
"uid": "模型 UID,可以根据此调用模型接口获取更加详细的数据",
"name": "展示名称,可能为空"
}
]
}
检查 Token 权限¶
检查指定工作区成员对一组 Token 的数据权限。返回结果与请求中的 tokens 数组按顺序一一对应,可用于在展示或提交问题前标记成员无权使用的 Token。
请求方式¶
Request Method: POST
Request URL: /openapi/v1/workspaces/{workspaceId}/tokens/permissions/
Request Header:
Authorization: "{连接密钥}"
请求参数¶
{
"memberUid": "9e823ddce2314f0ba2b2a8a6599a71a1",
"language": "zh-CN",
"tokens": [
{ "word": "销售额", "prop": "m2" },
{ "word": "利润", "prop": "m1" },
{ "word": "指标", "prop": "polysemy_bTE:bTI" }
]
}
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| workspaceId | string | 是 | 工作区 ID |
| memberUid | string | 是 | 当前工作区的成员 UID |
| language | string | 否 | 返回文案语言,可选 zh-CN 或 en-US,默认 zh-CN |
| tokens | array | 是 | 待检查的 Token 数组;每项的格式见下表 |
| tokens.word | string | 是 | Token 的展示文本 |
| tokens.prop | string | 是 | Token 的属性标识;可直接使用问题分词等接口返回的 prop |
| tokens.tuids | array | 否 | Token 关联的模型 UID 数组;行权限检查会使用该范围,如果上游接口返回了该字段,应保持原值传入 |
权限检查规则¶
| Token 类型 | prop 示例 |
检查规则 |
|---|---|---|
| 指标、维度 | m2、d1 |
检查成员的列权限 |
| 维度值 | d1.F=5YyX5Lqs |
检查成员的行权限;存在 tuids 时在指定模型范围内检查 |
| Dataset | ds123 |
Dataset 必须属于当前工作区且存在,并检查成员对 Dataset 所含全部字段的列权限 |
| 模型 | table_{modelUid} |
模型必须属于当前工作区且存在,并检查成员的模型权限 |
| 一词多义 | polysemy_bTE:bTI |
展开每个含义,分别按其 Token 类型检查 |
指标、维度、维度值和 Dataset Token 不叠加检查其关联模型的模型权限;只有 table_ 开头的模型 Token 检查模型权限。
返回结果¶
普通 Token 返回 正常 或 没有权限。一词多义 Token 会展开各个含义,并分别返回权限状态。以下示例与上面的三个 Token 按顺序对应:
{
"errcode": 200,
"errmsg": "success",
"data": ["正常", "没有权限", "利润 没有权限,销售额 有权限"]
}
指定 "language": "en-US" 时,返回英文文案:
{
"errcode": 200,
"errmsg": "success",
"data": ["Normal", "No permission", "利润 has no permission, 销售额 has permission"]
}
异常结果¶
- Token 缺少有效的
word或prop、类型无法识别,或者引用了当前工作区不存在的字段、Dataset 或模型时,该位置返回Token 不正确,请检查 token 的 word 和 prop 后重试。;英文为Invalid token. Check the token's word and prop, then try again.。Dataset ID 不是有效的 64 位有符号整数时也按非法 Token 处理。其他有效 Token 仍会正常检查,因此成功响应的data长度始终与tokens相同。 memberUid格式错误、成员不存在或成员不属于当前工作区时,整个请求返回错误:
{
"errcode": 400,
"errmsg": "成员 UID 不正确,请确认成员属于当前工作区后重试。"
}