注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
必須のロール
既存の組織内でプロジェクトを作成するには、指定された組織で次のいずれかのロールを持っている必要があります。
Resource
POST /groups
Request Parameters
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
name | string | 必須 | プロジェクトを識別する、人間に判読可能なラベル。 |
orgId | string | 必須 | プロジェクトを作成する組織を識別する一意の 24 桁の 16 進数string 。 Cloud Manager は、指定された組織の最も古い |
応答
名前 | タイプ | 説明 |
|---|---|---|
ActiveAgentCount | integer | Cloud Manager に定期的に ping を送信するアクティブなエージェントの数。 値は約24時間ごとに更新され、キャッシュされます。 新しいエージェントを開始するか、既存のエージェントを停止した場合、変更が |
hostCounts | オブジェクト | タイプ別のホストの合計数。 埋め込みフィールドは自己説明型である必要があります。 |
id | string | グループの一意の識別子です。 |
lastActiveAgent | string | Cloud Manager がプロジェクトの |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
name | string | プロジェクトの表示名。 |
orgId | string | プロジェクトが属する組織のユニーク識別子。 |
publicApiEnabled | ブール値 | このプロジェクトでAPIが有効になっていることを示すフラグ。 これは常に |
replicaSetCount | integer | このプロジェクトのレプリカセットの合計数。 |
shardCount | integer | このプロジェクトのシャードの合計数。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true" \ --data ' { "name": "Create Project API Example", "orgId": "deffb2031b938da53f16d714" }'
応答例
応答ヘッダー
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
201 Created 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}
レスポンス本体
{ "activeAgentCount" : 0, "agentApiKey" : "{GROUP-API-KEY}", "hostCounts" : { "arbiter" : 0, "config" : 0, "mongos" : 0, "primary" : 0, "secondary" : 0 }, "id" : "{PROJECT-ID}", "links" : [], "name" : "Create Project API Example", "orgId" : "{ORG-ID}", "publicApiEnabled" : true, "replicaSetCount" : 0, "shardCount" : 0, "tags" : [ ] }