翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
API キーを使用して Grafana HTTP APIs
Grafana APIs にアクセスする 1 つの方法は、API トークン とも呼ばれる API キー を使用することです。 API キーを作成するには、次のいずれかの手順を使用します。API キーは、作成時に指定した期間限定で、最大 30 日間有効です。
トピック
注記
バージョン 9 以降では、API キーの代わりにサービスアカウントを使用することをお勧めします。サービスアカウントは、Grafana API とやり取りするアプリケーションを認証する主な方法として APIs。Grafana Labs は、今後のリリースで API キーが削除されることを発表しました。
API キーを作成するときは、キーのロールを指定します。ロールは、キーのユーザーが持つ管理能力のレベルを決定します。
次の表は、管理者、エディタ、およびビューワーのロールに付与されたアクセス許可を示しています。最初の表は、組織の一般的なアクセス許可を示しています。この表では、フルとは、アクセス許可を表示、編集、追加、削除する機能を意味します。Explore 列には、ロールが Explore ビューを使用できるかどうかが表示されます。 その他のアクセス許可列には、ロールにユーザー、チーム、プラグイン、組織設定を管理するアクセス許可があるかどうかが表示されます。
| ロール | ダッシュボード | プレイリスト | フォルダ | 探索 | データソース | その他のアクセス許可 |
|---|---|---|---|---|---|---|
|
表示者 |
ビュー | ビュー | なし | いいえ | いいえ | なし |
|
[Editor] (エディタ) |
フル | フル | フル | あり | いいえ | なし |
|
Admin |
フル | フル | フル | あり | フル | フル |
次の表は、設定できる追加のダッシュボードレベルおよびフォルダレベルのアクセス許可を示しています。これらは、管理者、エディタ、ビューワーのロールとは異なります。
| ロール | ダッシュボード | フォルダ | 許可の変更 |
|---|---|---|---|
|
表示 |
ビュー | ビュー | なし |
|
[Edit] (編集) |
作成、編集 | ビュー | なし |
|
Admin |
作成、編集、削除 | 作成、編集、削除 | あり |
注記
アクセス許可レベルが低い、よりスコープの広いアクセス許可は、より多くのアクセス許可を持つより一般的なルールが存在する場合、効果がありません。例えば、ユーザーに組織のエディタロールを付与し、そのユーザーにダッシュボードの表示アクセス許可のみを割り当てると、エディタロールのためにユーザーに完全な編集アクセス許可があるため、より制限の厳しい表示アクセス許可は効果がありません。
ワークスペースの Grafana API で使用する Grafana APIs キーの作成 (コンソール）
注記
Grafana バージョン 10 以降と互換性のある Amazon Managed Grafana ワークスペースでは、ワークスペースに API キーを作成する機能が削除されました。ワークスペースが Grafana バージョン 10 ワークスペースの場合、API キーは AWS CLI または API からのみ作成できます。
API キーの削除は、今後のリリースで Grafana Labs によって発表されました。代わりにサービスアカウントを使用することをお勧めします。
ワークスペースコンソールで Grafana API で使用する Grafana APIs キーを作成するには
-
https://console.aws.amazon.com/grafana/
で Amazon Managed Grafana コンソールを開きます。 -
ページの左上隅にあるメニューアイコンを選択し、[すべての WorkSpaces] を選択します。
-
Amazon Managed Grafana ワークスペースの名前を選択します。
-
ワークスペースの詳細ページで、Grafana ワークスペース URL の下に表示される URL を選択します。
-
Grafana コンソールのサイドメニューで、設定 (歯車) アイコンで一時停止し、API キー を選択します。
-
新しい API キー を選択します。
-
キーの一意の名前を入力します。
-
ロール で、キーを付与するアクセスレベルを選択します。Admin を選択すると、このキーを持つユーザーが、最も広範で強力な管理レベルで APIsを使用できるようになります。Editor または Viewer を選択して、キーのユーザーをそれらのパワーレベルに制限します。詳細については、前の表を参照してください。
-
有効期限 には、キーを有効にする期間を指定します。最大は 30 日 (1 か月) です。数字と文字を入力します。有効な文字は、秒の場合は s、分の場合は m、時間の場合は h、日の場合は d、週の場合は w、月の場合は M です。例えば、12h は 12 時間、1M は 1 か月 (30 日) です。
キーの有効期間は、数時間以下など、より短く設定することを強くお勧めします。これにより、API キーを長期間有効にするよりもリスクがはるかに低くなります。
-
追加を選択します。
-
（オプション) Terraform を使用して API キーの作成 API を使用して API キーの作成を自動化できます。Terraform を使用した API キー作成の自動化の詳細については、「Terraform を使用した Grafana API キーの作成
」を参照してください。
を使用した Amazon Managed Grafana ワークスペース API キーの作成 AWS CLI
を使用して Amazon Managed Grafana ワークスペース API キーを作成するには AWS CLI
次の例では、key_name 、key_role 、seconds_to_live、Workspace_id をユーザー自身の情報に置き換えます。key-name、key-role、および の形式については seconds-to-live、 API ガイドhttps://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.htmlの「」を参照してください。
aws grafana create-workspace-api-key --key-name "key_name" --key-role "key_role" --seconds-to-liveseconds_to_live--workspace-id "workspace_id"
CLI レスポンスの例を次に示します。
次のコマンドを実行すると、ワークスペースの workspace_id を見つけることができます。
aws grafana list-workspaces
