プロジェクトにチームを追加する
項目一覧
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
注意
このエンドポイントは、 LDAP 認証を使用するプロジェクトと互換性がありません。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
構文
POST /groups/{PROJECT-ID}/teams
リクエスト パス パラメーター
path 要素 | 必須/オプション | 説明 |
|---|---|---|
PROJECT-ID | 必須。 | チームを追加するプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
プロジェクトに関連付ける 1 つのチームを表すドキュメントの配列を指定します。 配列内の各ドキュメントには、次のフィールドが含まれている必要があります。
名前 | タイプ | 説明 |
|---|---|---|
roleNames | 配列 | 配列内の各オブジェクトは、チームに割り当てるプロジェクト ロールを表します。 有効なロールとそれに関連付けられたマッピングは次のとおりです。
|
teamId | string | プロジェクトに関連付けるチームの一意の識別子。 チームとプロジェクトは同じ親組織を共有する必要があります。 |
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
result配列の各要素はプロジェクトに追加された 1 件のチームです。
名前 | タイプ | 説明 |
|---|---|---|
links | 配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
roleNames | 配列 | チームに割り当てられたプロジェクト ロールの配列。 有効なロールとそれに関連付けられたマッピングは次のとおりです。
|
リクエストの例
curl -u "username:apiKey" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams?pretty=true" \ --data '[ { "teamId" : "{TEAM-ID}", "roles" : [ { "roleName" : "GROUP_OWNER" } ] } ]'
応答例
応答ヘッダー
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
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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams", "rel": "self" } ], "results": [ { "links": [ { "href": "https://cloud.mongodb.com/api/pubic/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}", "rel": "self" } ], "roleNames": [ "GROUP_OWNER" ], "teamId": "{TEAM-ID}" } ], "totalCount": 1 }