获取指标标签列表
批量获取指标的标签信息,如标签名称、创建时间等信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/performance/v2/metric_tags |
| HTTP Method | GET |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | performance:metric:write 管理关键指标数据 performance:metric_lib:read 获取指标配置信息 performance:metric:read 获取关键指标数据 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小 默认值:20 示例值:10 数据校验规则: - 最大值: 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0= |
tag_ids | string\[\] | 否 | 指标标签 ID 列表,传此参数时不进行分页,不传时分页返回所有数据。 示例值:7283015566780547091 数据校验规则: - 长度范围: 0 ~ 9999 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | metric_tag\[\] | 指标标签列表 |
└ tag_id | string | 标签 ID |
└ tag_name | i18n | 标签名称 |
└ zh_cn | string | 标签中文 |
└ en_us | string | 标签英文 |
└ index | int | 标签顺序 |
└ create_time | string | 创建时间戳(单位:毫秒) |
└ update_time | string | 更新时间戳(单位:毫秒) |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"tag_id": "7302271694582841364",
"tag_name": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"index": 100,
"create_time": "1678870702466",
"update_time": "1605529625257"
}
],
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1580101 | internal error | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1580102 | param is invalid | 请求参数错误,检查请求参数是否合法 |
| 400 | 1580107 | page token invalid | page token 不存在 |
| 400 | 1580108 | page token expired | page token 已过期 |
| 400 | 1580901 | tenant no licnese | 租户无绩效席位,请联系租户管理员开通绩效席位 |
