注釈 API - Amazon Managed Grafana
注釈の検索注釈の作成グラファイト形式で注釈を作成する注釈の更新パッチアノテーションID で注釈を削除する

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

注釈 API

Annotations API を使用して、Amazon Managed Grafana ワークスペースで注釈を作成、更新、削除、操作します。

注釈はワークスペースの Grafana データベース (sqlite、mysql、postgres) に保存されます。注釈は、注釈データソースを設定することで、どのダッシュボードにも表示できるグローバル注釈にすることができます。注釈はタグでフィルタリングされます。または、ダッシュボードのパネルに紐付けして、そのパネルにのみ表示できます。

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorizationフィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証。

注釈の検索

GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100

リクエストの例

GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

クエリパラメータ：

  • from — (オプション) ミリ秒単位のエポック日時。

  • ～ — (オプション) ミリ秒単位のエポック日時。

  • limit — (オプション) 返される結果の最大数。デフォルトは 100 です。

  • alertid — (オプション) 指定されたアラートの注釈FInd。

  • dashboardId — (オプション) 指定されたダッシュボードにスコープされた注釈を検索します。

  • panelId — (オプション) 指定されたパネルにスコープされた注釈を検索します。

  • userId — (オプション) 指定したユーザーによって作成された注釈を検索します。

  • type — (オプション) アラートまたはユーザーが作成した注釈を返すには、 を指定します。値は alertおよび ですannotation。

  • tags — (オプション) グローバルアノテーションをフィルタリングするために使用します。グローバル注釈は、ダッシュボードまたはパネルに特に接続されていない注釈データソースからの注釈です。複数のタグで「AND」フィルタリングを実行するには、タグパラメータを複数回指定します。例えば tags=tag1&tags=tag2 です。これらは Grafana タグであり、 AWS タグではありません。

レスポンスの例

HTTP/1.1 200
Content-Type: application/json
[
    {
        "id": 1124,
        "alertId": 0,
        "dashboardId": 468,
        "panelId": 2,
        "userId": 1,
        "userName": "",
        "newState": "",
        "prevState": "",
        "time": 1507266395000,
        "timeEnd": 1507266395000,
        "text": "test",
        "metric": "",
        "tags": [
            "tag1",
            "tag2"
        ],
        "data": {}
    },
    {
        "id": 1123,
        "alertId": 0,
        "dashboardId": 468,
        "panelId": 2,
        "userId": 1,
        "userName": "",
        "newState": "",
        "prevState": "",
        "time": 1507265111000,
        "text": "test",
        "metric": "",
        "tags": [
            "tag1",
            "tag2"
        ],
        "data": {}
    }
]

注釈の作成

POST /api/annotations

ワークスペースの Grafana データベースに注釈を作成します。dashboardId および panelId フィールドはオプションです。指定しない場合、グローバルアノテーションが作成され、Grafana アノテーションデータソースを追加するダッシュボードでクエリを実行できます。リージョンアノテーションを作成するときは、必ず timeEndプロパティを含めてください。

time および の形式は、ミリ秒単位のエポック番号timeEndである必要があります。

リクエストの例

POST /api/annotations HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "dashboardId":468,
  "panelId":1,
  "time":1507037197339,
  "timeEnd":1507180805056,
  "tags":["tag1","tag2"],
  "text":"Annotation Description"
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation added",
    "id": 1,
}

グラファイト形式で注釈を作成する

POST /api/annotations/graphite

Graphite 互換イベント形式を使用して注釈を作成します。when および data フィールドはオプションです。が指定されwhenていない場合、現在の時刻が注釈のタイムスタンプとして使用されます。tags フィールドは、Graphite 0.10.0 形式 (スペースで区切られた複数のタグを含む文字列) より前の にすることもできます。

リクエストの例

POST /api/annotations/graphite HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "what": "Event - deploy",
  "tags": ["deploy", "production"],
  "when": 1467844481,
  "data": "deploy of master branch happened at Wed Jul 6 22:34:41 UTC 2016"
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Graphite annotation added",
    "id": 1
}

注釈の更新

PUT /api/annotations/:id

は、指定された ID に一致する注釈のすべてのプロパティを更新します。特定のプロパティのみを更新するには、パッチアノテーションオペレーションを使用します。

リクエストの例

PUT /api/annotations/1141 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Content-Type: application/json

{
  "time":1507037197339,
  "timeEnd":1507180805056,
  "text":"Annotation Description",
  "tags":["tag3","tag4","tag5"]
}

レスポンスの例：

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation updated"
}

パッチアノテーション

PATCH /api/annotations/:id

指定された ID に一致する注釈の 1 つ以上のプロパティを更新します。このオペレーションは現在、text、、tags、timeおよび timeEndプロパティの更新をサポートしています。

リクエストの例:

PATCH /api/annotations/1145 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Content-Type: application/json
       
{
   "text":"New Annotation Description",
   "tags":["tag6","tag7","tag8"]
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation patched"
}

ID で注釈を削除する

DELETE /api/annotations/:id

指定された ID に一致する注釈を削除します。

リクエストの例

DELETE /api/annotations/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
    "message":"Annotation deleted"
}