查询日期标识列表
接口描述
本接口用于查询当前租户下配置的日期标识列表。接入系统可使用日期标识识别指标看板中的业务日期字段。
接口URL
GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/datetag/list
服务地址
本文档中的接口 URL 使用以下占位符:
Http://{anymetrics_host:anymetrics_port}
anymetrics_host:anymetrics_port 获取方式请参考:调用方式。
公共请求参数(HEADERS)
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| tenant-id | String | 是 | 租户 ID,用于标识本次请求访问的 AnyMetrics 租户。 |
| auth-type | String | 是 | 认证方式。支持 UID、TOKEN、ACCOUNT、APIKEY。 |
| auth-value | String | 是 | 与 auth-type 对应的认证值。 |
| Content-Type | String | POST 请求必选 | 固定为 application/json。 |
| Accept-Language | String | 否 | 语言标识,例如 zh-CN。 |
公共响应参数
除特殊说明外,接口响应均使用统一包装结构:
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| data | Object | 否 | 接口业务数据。不同接口的 data 结构不同,详见各接口说明。 |
||
| success | Boolean | 是 | 是否成功。 | true | |
| code | String | 是 | 32 | 接口响应码,成功时为 200。 |
200 |
| errorMsg | String | 否 | 512 | 请求失败时的错误信息。 | null |
| detailErrorMsg | String | 否 | 512 | 请求失败时的错误详情;成功时为空。 | null |
| traceId | String | 是 | 128 | 请求链路追踪 ID,用于排查问题。 | 4b5d80fad0fc44d0937253362b4e9da5.79456.17490900608203107 |
请求参数
无。
响应参数
data 参数说明
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| id | Long | 是 | 日期标识 ID。 | 1001 | |
| name | String | 是 | 日期标识中文名或展示名。 | 订单日期 | |
| enName | String | 是 | 日期标识英文名。 | order_date | |
| exprCode | String | 是 | Semantic 侧日期标识 ID。 | 900001 | |
| description | String | 否 | 日期标识描述。 | 订单发生日期 | |
| columnName | String | 否 | 绑定的列名。 | order_date |
请求示例
curl --location --request GET 'http://127.0.0.1:8083/anymetrics/api/v1/datetag/list' \
--header 'tenant-id: tn_19487697' \
--header 'auth-type: UID' \
--header 'auth-value: 463663891121963008'