/ /

/ /

1 つのプロジェクトのすべてのチームを取得

注意

グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループを使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。

ベース URL: https://cloud.mongodb.com/api/public/v1.0

構文

GET /groups/{PROJECT-ID}/teams

リクエストパスパラメーター

path 要素	必須/オプション	説明
`PROJECT-ID`	必須。	プロジェクトの一意の識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。 Some API clients cannot access the HTTP response headers or status code. To remediate this, set `envelope : true` in the query. 結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

result配列の各要素は、プロジェクトに割り当てられた 1 つのチームです。

名前	タイプ	説明
`links`	オブジェクト配列	この配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれています。 URL 間の関係は、Web リンク仕様で説明されています。
`roleNames`	string 配列	チームに割り当てられたプロジェクトロールの配列。
`teamId`	string	チームの一意の識別子。

リクエストの例

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
 "links": [
   {
    "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams",
    "rel": "self"
   }
 ],
 "results": [
   {
    "links" : [
      {
        "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID}",
        "rel": "self"
      }
    ],
    "roleNames": [
      "GROUP_READ_ONLY"
    ],
    "teamId": "{TEAM-ID}"
   }
 ],
 "totalCount": 1
}