查询时间限定列表

接口描述

本接口用于查询当前租户下配置的时间限定列表。接入系统可使用该接口获取指标看板中可选的时间范围、时间粒度和时间限定类型。

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/period/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。	1
name	String	是		时间限定名称，通常为英文标识。	mtd
displayName	String	是		时间限定展示名。	本月至今
periodGrain	String	否		时间粒度。可能值包括 DAY、WEEK、MONTH、QUARTER、YEAR 等。	MONTH
timeRange	String	否		时间范围表达式。
type	String	否		时间限定类型，例如 GRAIN_TO_DATE、TO_DATE、RELATIVE_DATE 等。	GRAIN_TO_DATE
typeParams	String	否		时间限定类型参数，通常为 JSON 字符串。	{"grain":"MONTH"}
onlyContainsDateTag	String	否		是否仅包含指定日期标识。

请求示例

curl --location --request GET 'http://127.0.0.1:8083/anymetrics/api/v1/period/list' \
--header 'tenant-id: tn_19487697' \
--header 'auth-type: UID' \
--header 'auth-value: 463663891121963008'

响应示例

{
  "data": [
    {
      "id": 1,
      "name": "mtd",
      "displayName": "本月至今",
      "periodGrain": "MONTH",
      "timeRange": null,
      "type": "GRAIN_TO_DATE",
      "typeParams": "{\"grain\":\"MONTH\"}",
      "onlyContainsDateTag": null
    }
  ],
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": "4b5d80fad0fc44d0937253362b4e9da5.79456.17490900608203107"
}