알림 관리 경보 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

알림 관리 경보 API는 메트릭 이미지로 제한됩니다. 더 많은 API 엔드포인트를 보려면 GraphQL API을 참조하세요.

메트릭 이미지 업로드 

POST /projects/:id/alert_management_alerts/:alert_iid/metric_images
속성 유형 필요 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩 경로입니다.
alert_iid 정수 예 프로젝트의 경보의 내부 ID입니다. 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"  --form 'file=@/path/to/file.png' \
--form 'url=http://example.com' --form 'url_text=Example website' "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images"

예시 응답: 

{
    "id": 17,
    "created_at": "2020-11-12T20:07:58.156Z",
    "filename": "sample_2054",
    "file_path": "/uploads/-/system/alert_metric_image/file/17/sample_2054.png",
    "url": "https://example.com/metric",
    "url_text": "An example metric"
}

메트릭 이미지 목록 

GET /projects/:id/alert_management_alerts/:alert_iid/metric_images
속성 유형 필요 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩 경로입니다.
alert_iid 정수 예 프로젝트의 경보의 내부 ID입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images"

예시 응답: 

[
    {
        "id": 17,
        "created_at": "2020-11-12T20:07:58.156Z",
        "filename": "sample_2054",
        "file_path": "/uploads/-/system/alert_metric_image/file/17/sample_2054.png",
        "url": "https://example.com/metric",
        "url_text": "An example metric"
    },
    {
        "id": 18,
        "created_at": "2020-11-12T20:14:26.441Z",
        "filename": "sample_2054",
        "file_path": "/uploads/-/system/alert_metric_image/file/18/sample_2054.png",
        "url": "https://example.com/metric",
        "url_text": "An example metric"
    }
]

메트릭 이미지 업데이트 

PUT /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id
속성 유형 필요 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩 경로입니다.
alert_iid 정수 예 프로젝트의 경보의 내부 ID입니다.
image_id 정수 예 이미지의 ID입니다.
url 문자열 아니오 더 많은 메트릭 정보를 보기 위한 URL입니다.
url_text 문자열 아니오 이미지 또는 URL에 대한 설명입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" --request PUT  --form 'url=http://example.com' --form 'url_text=Example website' "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images/1"

예시 응답: 

{
    "id": 23,
    "created_at": "2020-11-13T00:06:18.084Z",
    "filename": "file.png",
    "file_path": "/uploads/-/system/alert_metric_image/file/23/file.png",
    "url": "https://example.com/metric",
    "url_text": "An example metric"
}

메트릭 이미지 삭제 

DELETE /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id
속성 유형 필요 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩 경로입니다.
alert_iid 정수 예 프로젝트의 경보의 내부 ID입니다.
image_id 정수 예 이미지의 ID입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images/1"

다음과 같은 상태 코드를 반환할 수 있습니다:

  • 204 No Content: 이미지가 성공적으로 삭제된 경우.
  • 422 Unprocessable: 이미지를 삭제할 수 없는 경우.