ユーザー定義のメトリクス・ダッシュボードAPI
スター付きダッシュボード機能は、お気に入りのダッシュボードを選択リストの一番上に表示することで、頻繁に使用するダッシュボードへのナビゲーションを容易にします。
ダッシュボードに星を追加
GitLab 13.0から導入されました。
POST /projects/:id/metrics/user_starred_dashboards
パラメータを指定します：
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | プロジェクトのIDまたはURLエンコードされたパス |
dashboard_path | 文字列です。 | 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 | 整数/文字列 | yes | プロジェクトのIDまたはURLエンコードされたパス |
dashboard_path | 文字列です。 | いいえ | お気に入りとしてマークされなくなるダッシュボードを定義するファイルへの 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
}