指标生成和查询相关功能api
This commit is contained in:
69
doc/指标api.md
Normal file
69
doc/指标api.md
Normal file
@ -0,0 +1,69 @@
|
||||
# 新建指标
|
||||
curl -X POST "/api/v1/metrics" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"metric_code": "metric_1234",
|
||||
"metric_name": "订单数",
|
||||
"biz_domain": "order",
|
||||
"biz_desc": "订单总数",
|
||||
"base_sql": "select count(*) as order_cnt from orders",
|
||||
"time_grain": "DAY",
|
||||
"dim_binding": ["dt"],
|
||||
"update_strategy": "FULL",
|
||||
"metric_aliases": ["订单量"],
|
||||
"created_by": '"$METRIC_USER_ID"'
|
||||
}'
|
||||
|
||||
# 更新指标
|
||||
curl -X POST "/api/v1/metrics/{metric_id}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"metric_name":"订单数-更新","is_active":false}'
|
||||
|
||||
# 获取指标
|
||||
curl "/api/v1/metrics/{metric_id}"
|
||||
|
||||
# 新建调度
|
||||
curl -X POST "/api/v1/metric-schedules" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"metric_id":{metric_id},"cron_expr":"0 2 * * *","priority":5,"enabled":true}'
|
||||
|
||||
# 更新调度
|
||||
curl -X POST "/api/v1/metric-schedules/{schedule_id}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"enabled":false,"retry_times":1}'
|
||||
|
||||
# 列出某指标的调度
|
||||
curl "/api/v1/metrics/{metric_id}/schedules"
|
||||
|
||||
# 触发运行
|
||||
curl -X POST "/api/v1/metric-runs/trigger" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"metric_id": {metric_id},
|
||||
"triggered_by": "API",
|
||||
"data_time_from": "2024-05-01T00:00:00Z",
|
||||
"data_time_to": "2024-05-02T00:00:00Z"
|
||||
}'
|
||||
|
||||
# 列出运行
|
||||
curl "/api/v1/metric-runs?metric_id={metric_id}"
|
||||
|
||||
# 获取单次运行
|
||||
curl "/api/v1/metric-runs/{run_id}"
|
||||
|
||||
# 写入指标结果
|
||||
curl -X POST "/api/v1/metric-results/{metric_id}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"metric_id": {metric_id},
|
||||
"results": [
|
||||
{"stat_time":"2024-05-01T00:00:00Z","metric_value":123.45,"data_version":"{run_id}"},
|
||||
{"stat_time":"2024-05-02T00:00:00Z","metric_value":234.56,"data_version":"{run_id}"}
|
||||
]
|
||||
}'
|
||||
|
||||
# 查询指标结果
|
||||
curl "/api/v1/metric-results?metric_id={metric_id}"
|
||||
|
||||
# 查询最新结果
|
||||
curl "/api/v1/metric-results/latest?metric_id={metric_id}"
|
||||
Reference in New Issue
Block a user