翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
認証 API を使用して Amazon Managed Grafana ワークスペースの認証キーを操作します。
注記
Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。このトークンは API リクエストの Authorization フィールドに含めます。API コールを認証するトークンの作成方法については、「トークンを使用した認証」を参照してください。
API キーの取得
GET /api/auth/keysリクエストの例
GET /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbkクエリパラメーター:
-
includeExpired — (オプション) 返される結果に期限切れキーを含めるかどうかを指定する、ブールパラメータです。デフォルト:
false。
レスポンスの例
HTTP/1.1 200
Content-Type: application/json
[
{"id": 3,"name": "API","role": "Admin"},
{"id": 1,"name": "TestAdmin","role": "Admin","expiration": "2019-06-26T10:52:03+03:00"}
]API キーの作成
POST /api/auth/keysリクエストの例
POST /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"name": "mykey",
"role": "Admin",
"secondsToLive": 86400
}JSON ボディスキーマ:
-
[名前] — キーの名前です。
-
role — キーのアクセスレベル (Grafana ロール) を設定します。有効な値は
Admin、Editor、またはViewerです。 -
secondsToLive — キーの有効期限が切れるまでの合計時間を設定します。2592000 (30 日) 以下にする必要があります。
レスポンスの例
{"name":"mykey","key":"eyJrIjoiWHZiSWd3NzdCYUZnNUtibE9obUpESmE3bzJYNDRIc0UiLCJuIjoibXlrZXkiLCJpZCI6MX1=","id":1}エラーステータス:
-
400 —
secondsToLiveが 2592000 より大きい -
500 — データベースにキーを保存できませんでした。
API キーの削除
DELETE /api/auth/keys/:idリクエストの例
DELETE /api/auth/keys/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbkレスポンスの例
HTTP/1.1 200
Content-Type: application/json
{"message":"API key deleted"}