データソースアクセス許可 API - Amazon Managed Grafana

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

データソースアクセス許可 API

データソースのアクセス許可 API を使用して、データソースのアクセス許可を有効化、無効化、一覧表示、追加、削除します。

ユーザーまたはチームのアクセス許可を設定できます。アクセス許可は、常にすべてにアクセスできるため、管理者には設定できません。

アクセス許可フィールドのアクセス許可レベルは次のとおりです。

  • 1 = クエリ

注記

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

データソースのアクセス許可を有効にする

POST /api/datasources/:id/enable-permissions

指定された ID を持つデータソースのアクセス許可を有効にします。特定のユーザーまたはチームがデータソースをクエリすることを許可するアクセス許可が追加されるまで、組織管理者以外の誰もデータソースをクエリできません。

リクエストの例

POST /api/datasources/1/enable-permissions Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 35 {"message":"Datasource permissions enabled"}

ステータスコード:

  • 200 - 作成済み

  • 400 - アクセス許可を有効にすることはできません。詳細については、レスポンス本文を参照してください。

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - データソースが見つかりません

データソースのアクセス許可を無効にする

POST /api/datasources/:id/disable-permissions

指定された ID を持つデータソースのアクセス許可を無効にします。既存のアクセス許可はすべて削除され、誰でもデータソースをクエリできます。

リクエストの例

POST /api/datasources/1/disable-permissions Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk {}

レスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 35 {"message":"Datasource permissions disabled"}

ステータスコード:

  • 200 - OK

  • 400 - アクセス許可を無効にすることはできません。詳細については、レスポンス本文を参照してください。

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - データソースが見つかりません

データソースのアクセス許可を取得する

GET /api/datasources/:id/permissions

指定された を使用して、データソースに対する既存のアクセス許可をすべて取得しますid

リクエストの例

GET /api/datasources/1/permissions HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 551 { "datasourceId": 1, "enabled": true, "permissions": [ { "id": 1, "datasourceId": 1, "userId": 1, "userLogin": "user", "userEmail": "user@test.com", "userAvatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae", "permission": 1, "permissionName": "Query", "created": "2017-06-20T02:00:00+02:00", "updated": "2017-06-20T02:00:00+02:00", }, { "id": 2, "datasourceId": 1, "teamId": 1, "team": "A Team", "teamAvatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae", "permission": 1, "permissionName": "Query", "created": "2017-06-20T02:00:00+02:00", "updated": "2017-06-20T02:00:00+02:00", } ] }

ステータスコード:

  • 200 - OK

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - データソースが見つかりません

データソースのアクセス許可を追加する

POST /api/datasources/:id/permissions

指定された でデータソースのユーザーアクセス許可を追加しますid

ユーザーアクセス許可を追加するリクエストの例

POST /api/datasources/1/permissions Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "userId": 1, "permission": 1 }

ユーザーアクセス許可を追加するためのレスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 35 {"message":"Datasource permission added"}

チームアクセス許可を追加するリクエストの例

POST /api/datasources/1/permissions Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "teamId": 1, "permission": 1 }

チームアクセス許可を追加するためのレスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 35 {"message":"Datasource permission added"}

ステータスコード:

  • 200 - OK

  • 400 - アクセス許可を追加できません。詳細については、「レスポンス本文」を参照してください。

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - データソースが見つかりません

データソースのアクセス許可を削除する

DELETE /api/datasources/:id/permissions/:permissionId

指定された を持つデータソースの指定された permissionId を持つ アクセス許可を削除しますid

リクエストの例

DELETE /api/datasources/1/permissions/2 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 Content-Length: 35 {"message":"Datasource permission removed"}

ステータスコード:

  • 200 - OK

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - データソースが見つからないか、アクセス許可が見つかりません