用户星标的指标仪表板 API

星标的仪表板功能可以在选择列表顶部显示收藏的仪表板,从而使用户更容易导航到常用仪表板。

向仪表板添加星标

引入于极狐GitLab 13.0。

POST /projects/:id/metrics/user_starred_dashboards

参数:

参数 类型 是否必需 描述
id integer/string yes ID 或 URL 编码的项目路径
dashboard_path string yes URL 编码的文件路径,该文件定义应该被标为收藏的仪表板
curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \
 --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml"

响应示例:

{
  "id": 5,
  "dashboard_path": "config/prometheus/common_metrics.yml",
  "user_id": 1,
  "project_id": 20
}

从仪表板移除星标

引入于极狐GitLab 13.0。

DELETE /projects/:id/metrics/user_starred_dashboards

参数:

参数 类型 是否必需 描述
id integer/string yes ID 或 URL 编码的项目路径
dashboard_path string no URL 编码的文件路径,该文件定义不应被标为收藏的仪表板。如未提供,给定项目中的所有仪表板都会被取消收藏
curl --request DELETE --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \
 --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml"

响应示例:

{
  "deleted_rows": 1
}