チーム API - Amazon Managed Grafana
ページ分割によるチーム検索ID でチームを取得するチームを追加するチームの更新ID でチームを削除するチームメンバーを取得するチームメンバーを追加するチームからメンバーを削除するチーム設定を取得するチームの設定を更新する

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

チーム API

Team API を使用して、Amazon Managed Grafana ワークスペース内のチームを操作します。この API のすべてのアクションには、管理者ロールが必要です。

注記

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

ページ分割によるチーム検索

GET /api/teams/search?perpage=50&page=1&query=myteam

または

GET /api/teams/search?name=myteam

リクエストの例

GET /api/teams/search?perpage=10&page=1&query=myteam HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

クエリパラメータの使用

perpage パラメータのデフォルト値は 1000 で、 pageパラメータのデフォルト値は 1 です。

レスポンスの totalCountフィールドは、チームリストのページ分割に使用できます。例えば、 totalCountが 100 チームで、 perpageパラメータが 10 に設定されている場合、10 ページのチームがあります。

query パラメータはオプションで、クエリ値が nameフィールドに含まれている結果を返します。スペースを含むクエリ値は URL エンコードする必要があります。例えば query=my%20team です。

name パラメータの使用

name パラメータが nameフィールドと一致する場合、 パラメータは 1 つのチームを返します。

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
  "totalCount": 1,
  "teams": [
    {
      "id": 1,
      "orgId": 1,
      "name": "MyTestTeam",
      "email": "",
      "avatarUrl": "\/avatar\/3f49c15916554246daa714b9bd0ee39",
      "memberCount": 1
    }
  ],
  "page": 1,
  "perPage": 1000

ステータスコード：

  • 200 - 作成済み

  • 401 - 未認可

  • 403 - アクセス許可が拒否されました

  • 404 - チームが見つからない (名前で検索した場合）

ID でチームを取得する

GET /api/teams/:id

リクエストの例

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

レスポンスの例

HHTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "orgId": 1,
  "name": "MyTestTeam",
  "email": "",
  "created": "2017-12-15T10:40:45+01:00",
  "updated": "2017-12-15T10:40:45+01:00"
}

チームを追加する

チームの nameは一意である必要があります。name フィールドは必須で、 email および orgIdフィールドはオプションです。

POST /api/teams

リクエストの例

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

{
  "name": "MyTestTeam",
  "email": "email@test.com",
  "orgId": 2
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Team created","teamId":2}

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

  • 409 - チーム名は既に存在します

チームの更新

PUT /api/teams/:id

更新できるのは nameおよび emailフィールドのみです。

リクエストの例

PUT /api/teams/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
        
{
  "name": "MyTestTeam",
  "email": "email@test.com"
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Team updated"}

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

  • 404 - チームが見つかりません

  • 409 - チーム名は既に存在します

ID でチームを削除する

DELETE /api/teams/:id

リクエストの例

DELETE /api/teams/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Team deleted"}

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

  • 404 - チームが見つかりません

チームメンバーを取得する

GET /api/teams/:teamId/members

リクエストの例

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

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 3,
    "email": "user1@email.com",
    "login": "user1",
    "avatarUrl": "\/avatar\/1b3c32f6386b0185c40d359cdc733a7"
  },
  {
    "orgId": 1,
    "teamId": 1,
    "userId": 2,
    "email": "user2@email.com",
    "login": "user2",
    "avatarUrl": "\/avatar\/cad3c68da76e45d10269e8ef02f8e7"
  }
]

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

チームメンバーを追加する

POST /api/teams/:teamId/members

リクエストの例

POST /api/teams/1/members HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
      
{
  "userId": 2
}

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Member added to Team"}

ステータスコード：

  • 200 - 作成済み

  • 400 - ユーザーはすでにチームに入っています

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

  • 404 - チームが見つかりません

チームからメンバーを削除する

DELETE /api/teams/:teamId/members/:userId

リクエストの例

DELETE /api/teams/2/members/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"message":"Team Member removed"}

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス許可が拒否されました

  • 404 - チームが見つからない/チームメンバーが見つかりません

チーム設定を取得する

GET /api/teams/:teamId/preferences

リクエストの例

GET /api/teams/2/preferences HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{
  "theme": "",
  "homeDashboardId": 0,
  "timezone": ""
}

チームの設定を更新する

PUT /api/teams/:teamId/preferences

リクエストの例

PUT /api/teams/2/preferences HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "theme": "dark",
  "homeDashboardId": 39,
  "timezone": "utc"
}

JSON 本文スキーマ：

  • theme — デフォルトのテーマを使用するにはlight、、dark、または空の文字列を指定します。

  • homeDashboardId— ダッシュボード:idの数値。デフォルトは 0 です。

  • timezone — デフォルトを使用するにはutc、、browser、または空の文字列を指定します。

パラメータを省略すると、現在の値がシステムのデフォルト値に置き換えられます。

レスポンスの例

HTTP/1.1 200
Content-Type: text/plain; charset=utf-8

{
  "message":"Preferences updated"
}