대시보드 주석 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
  • GitLab 12.10에서 비활성화된 기능 플래그 뒤에 소개되었습니다.

메트릭 대시보드 주석을 사용하면 그래프에서 단일 시점이나 시간 범위에 걸친 이벤트를 나타낼 수 있습니다.

새 주석 만들기 

POST /environments/:id/metrics_dashboard/annotations/
POST /clusters/:id/metrics_dashboard/annotations/

매개변수:

속성 타입 필수 설명
dashboard_path 문자열 예 주석이 필요한 대시보드의 ID. CGI 이스케이프된 경로로 취급되며 자동으로 언이스케이프됩니다.
starting_at 문자열 예 ISO 8601 형식의 날짜 및 시간 문자열, 예: 2016-03-11T03:45:40Z. 주석의 시작 지점을 표시하는 타임스탬프입니다.
ending_at 문자열 아니요 ISO 8601 형식의 날짜 및 시간 문자열, 예: 2016-03-11T03:45:40Z. 주석의 끝 지점을 표시하는 타임스탬프입니다. 제공되지 않으면 주석은 시작 지점에서 단일 이벤트로 표시됩니다.
description 문자열 예 주석 설명 
curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations" \
 --data-urlencode "dashboard_path=.gitlab/dashboards/custom_metrics.yml" \
 --data-urlencode "starting_at=2016-03-11T03:45:40Z" \
 --data-urlencode "description=주석 설명"

예시 응답: 

{
  "id": 4,
  "starting_at": "2016-04-08T03:45:40.000Z",
  "ending_at": null,
  "dashboard_path": ".gitlab/dashboards/custom_metrics.yml",
  "description": "주석 설명",
  "environment_id": 1,
  "cluster_id": null
}