アラート管理アラートAPI

Alert Management alerts API はメトリクス画像に限定されています。その他の API エンドポイントについては、GraphQL API を参照してください。

メトリック画像のアップロード 

POST /projects/:id/alert_management_alerts/:alert_iid/metric_images
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス。
alert_iid整数。yesプロジェクトのアラートの内部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整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス。
alert_iid整数。yesプロジェクトのアラートの内部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整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス。
alert_iid整数。yesプロジェクトのアラートの内部ID。
image_id整数。yes画像の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整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス。
alert_iid整数。yesプロジェクトのアラートの内部ID。
image_id整数。yes画像の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画像の削除に失敗した場合。