グラフアノテーションの作成
POST
/api/v0/graph-annotations
APIキーに必要な権限
- Read
- Write
入力
KEY | TYPE | DESCRIPTION |
---|---|---|
title |
string | アノテーションのタイトル |
description |
string | [optional] アノテーションの詳細 |
from |
number | 開始時刻 (epoch秒) |
to |
number | 終了時刻 (epoch秒) |
service |
string | サービス名 |
roles |
array[string] | [optional] ロール名の配列。このフィールドを指定しない場合は、サービスに紐づくアノテーションとなる |
入力例
{ "title": "deploy application", "description": "link: https://example.com/", "from": 1484000000, "to": 1484000030, "service": "ExampleService", "roles": [ "ExampleRole1", "ExampleRole2" ] }
応答
入力にidが付与されて返却されます。
失敗時
STATUS CODE | DESCRIPTION |
---|---|
400 | 入力が受け付けられないフォーマットだったとき |
400 | titleが250文字もしくはdescriptionが1024文字を超えているとき |
400 | 開始時刻が終了時刻を超えているとき |
404 | サービスやロールが存在しないとき |
403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
グラフアノテーションの取得
サービスと期間を指定して、グラフのアノテーションの一覧を取得します。 指定された期間と共通部分があるアノテーションが全て返却されます。
GET
/api/v0/graph-annotations
APIキーに必要な権限
- Read
入力 (クエリパラメータ)
PARAM | TYPE | DESCRIPTION |
---|---|---|
service |
string | サービス名 |
from |
number | 取得するアノテーションの期間の最初 (epoch秒) |
to |
number | 取得するアノテーションの期間の最後 (epoch秒) |
応答
{ "graphAnnotations": [ { "id": "2UdH1QcZQaw", "title": "Deploy application", "description": "Deploy description", "from": 1484020459, "to": 1484020759, "service": "ExampleService" }, { "id": "2UdH1QuiGgj", "title": "Release application", "description": "Release description", "from": 1484021239, "to": 1484021239, "service": "ExampleService", "roles": [ "ExampleRole1", "ExampleRole2" ] } ] }
失敗時
STATUS CODE | DESCRIPTION |
---|---|
400 | 必要なクエリパラメータが指定されていないとき |
404 | 指定されたサービスが存在しない時 |
グラフアノテーションの更新
PUT
/api/v0/graph-annotations/<annotationId>
APIキーに必要な権限
- Read
- Write
入力
グラフアノテーションの作成と同様です。
応答
グラフアノテーションの作成と同様、idが付与されて返却されます。
失敗時
STATUS CODE | DESCRIPTION |
---|---|
400 | 入力が受け付けられないフォーマットだったとき |
400 | titleが250文字もしくはdescriptionが1024文字を超えているとき |
400 | 開始時刻が終了時刻を超えているとき |
404 | サービスやロールが存在しないとき |
404 | グラフのアノテーションが存在しないとき |
403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
グラフアノテーションの削除
DELETE
/api/v0/graph-annotations/<annotationId>
APIキーに必要な権限
- Read
- Write
応答
成功時
削除前のグラフのアノテーションが返却されます。
失敗時
STATUS CODE | DESCRIPTION |
---|---|
404 | グラフのアノテーションが存在しないとき |
403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |