翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
フォルダ API
Folder API を使用して、Amazon Managed Grafana ワークスペースのフォルダを操作します。
フォルダの識別子 (id) は自動増分の数値であり、ワークスペースごとにのみ一意です。フォルダの一意の識別子 (uid) を使用して、複数のワークスペース間のフォルダを一意に識別できます。フォルダの作成時に指定しない場合、自動的に生成されます。uid を使用すると、フォルダにアクセスしたり、複数の Amazon Managed Grafana ワークスペース間でフォルダを同期したりするための一貫した URLs を設定できます。uid を使用すると、フォルダのタイトルを変更しても、そのフォルダへのブックマークされたリンクが破損することはありません。
uid の最大長は 40 文字です。
フォルダはネストできません。
注記
Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorization
フィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証。
が 0 id
の General フォルダは、Folder API の一部ではありません。Folder API を使用して、一般フォルダに関する情報を取得することはできません。
フォルダの作成
POST /api/folders
新しいフォルダを作成します。
リクエストの例
POST /api/folders HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "uid": "nErXDvCkzz", "title": "Department ABC" }
JSON 本文スキーマ:
-
uid — オプションの一意の識別子。null の場合、新しい uid が生成されます。
-
title — フォルダのタイトル。
レスポンスの例
HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 }
ステータスコード:
-
200 - 作成済み
-
400 - 無効な JSON、無効なフィールド、欠落しているフィールドなどのエラー
-
401 - 未承認
-
403 - アクセスが拒否されました
フォルダの更新
PUT /api/folders/:uid
uid に一致する既存のフォルダを更新します。
リクエストの例
PUT /api/folders/nErXDvCkzz HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "title":"Department DEF", "version": 1 }
JSON 本文スキーマ:
-
uid — 指定された場合は、一意の識別子を変更します。
-
title — フォルダのタイトル。
-
version — フォルダを上書きできるように、現在のバージョンを指定します。の場合は必要ありません
overwrite=true
。 -
overwrite — 既存のフォルダを新しいバージョンで上書き
true
するには、 に設定します。
レスポンスの例
HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department DEF", "url": "/dashboards/f/nErXDvCkzz/department-def", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 }
ステータスコード:
-
200 - 作成済み
-
400 - 無効な JSON、無効なフィールド、欠落しているフィールドなどのエラー
-
401 - 未承認
-
403 - アクセス拒否
-
404 - フォルダが見つかりません
-
412 - 前提条件が失敗しました
412 ステータスコードは、フォルダを更新できない理由を説明するために使用されます。
-
フォルダが他のユーザーによって変更されている
status=version-mismatch
レスポンス本文には次のプロパティがあります。
HTTP/1.1 412 Precondition Failed Content-Type: application/json; charset=UTF-8 Content-Length: 97 { "message": "The folder has been changed by someone else", "status": "version-mismatch" }
すべてのフォルダを取得する
GET /api/folders
表示するアクセス許可を持つすべてのフォルダを返します。limit
クエリパラメータを使用して、返されるフォルダの最大数を制御できます。デフォルトは 1000 です。
リクエストの例
GET /api/folders?limit=10 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
レスポンスの例
HTTP/1.1 200 Content-Type: application/json [ { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC" }, { "id":2, "uid": "k3S1cklGk", "title": "Department RND" } ]
uid でフォルダを取得する
GET /api/folders/:uid
指定された uid に一致するすべてのフォルダを返します。
リクエストの例
GET /api/folders/nErXDvCkzzh HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
レスポンスの例
HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 }
ステータスコード:
-
200 - 見つかりました
-
401 - 未承認
-
403 - アクセス拒否
-
404 - 見つかりません
ID でフォルダを取得する
GET /api/folders/id/:id
指定された ID に一致するフォルダを返します。
リクエストの例
GET /api/folders/id/1 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
レスポンスの例
HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 }
ステータスコード:
-
200 - 見つかりました
-
401 - 未承認
-
403 - アクセス拒否
-
404 - 見つかりません
uid でフォルダを削除する
DELETE /api/folders/:uid
uid に一致するフォルダを削除し、フォルダに保存されているすべてのダッシュボードも削除します。このオペレーションは元に戻すことができません。
リクエストの例
DELETE /api/folders/nErXDvCkzz HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
レスポンスの例
HTTP/1.1 200 Content-Type: application/json { "message":"Folder deleted", "id": 2 }
ステータスコード:
-
200 - 削除済み
-
401 - 未承認
-
403 - アクセスが拒否されました
-
404 - 見つかりません