名前を使用して 1 つのプロジェクトを取得
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/byName/{GROUP-NAME}
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
グループ名 | string | （必須。） プロジェクトの名前。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActiveAgentCount | integer | MongoDB Ops Manager に定期的に ping を送信するアクティブなエージェントの数。 値は約24時間ごとに更新され、キャッシュされます。 新しいエージェントを開始するか、既存のエージェントを停止した場合、変更が | ||||||||||||||||||
hostCounts | オブジェクト | タイプ別のホストの合計数。 埋め込みフィールドは自己説明型である必要があります。 | ||||||||||||||||||
id | string | プロジェクトの一意の識別子です。 | ||||||||||||||||||
lastActiveAgent | string | MongoDB Ops Managerがプロジェクトの activeAgentCount の合計を最後に更新した時間。 MongoDB Ops Manager は 24 時間ごとにこの値を更新し、アクティブな MongoDB エージェントの数を記録するためにキャッシュします。 | ||||||||||||||||||
ldapGroupMappings | オブジェクト配列 | ベースの LDAPMongoDB Ops Managerの場合、LDAP プロジェクト ロールへの グループ のマッピング。MongoDB Ops ManagerLDAP ベースのMongoDB Ops Managerにのみ存在します。 | ||||||||||||||||||
ldapGroupMappings .roleName | string | MongoDB Ops Manager ユーザー ロール。 プロジェクト ロールの
| ||||||||||||||||||
ldapGroupMappings .ldapGroups | string 配列 | MongoDB Ops Manager ロールにマッピングする LDAP プロジェクト。 | ||||||||||||||||||
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての | ||||||||||||||||||
name | string | プロジェクトの表示名。 | ||||||||||||||||||
orgId | string | プロジェクトが属する組織のユニーク識別子。 | ||||||||||||||||||
publicApiEnabled | ブール値 | このプロジェクトでAPIが有効になっていることを示すフラグ。 これは常に trueである読み取り専用フィールドです。 | ||||||||||||||||||
replicaSetCount | integer | このプロジェクトのレプリカセットの合計数。 | ||||||||||||||||||
shardCount | integer | このプロジェクトのシャードの合計数。 | ||||||||||||||||||
tags | string 配列 | プロジェクトをプログラム的に識別するために使用されるプロジェクトに割り当てられたタグ。
プロジェクトには最大 10 個のタグを含めることができます。 タグは次のルールに従います。
|
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"
重要
一部の文字は URL では許可されません。 これらは 予約文字 と呼ばれます 。{GROUP-NAME}にスペースなどの予約文字が含まれている場合は、 パーセント エンコーディング で置き換える必要があります 。
たとえば、このリクエスト（ curl 経由）を行う代わりに、次のようにします。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"
このリクエストを行います（ curl 経由）。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?pretty=true"
応答例
応答ヘッダー
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}
レスポンス本体
{ "activeAgentCount": 1, "agentApiKey": "{AGENT-API-KEY}", "hostCounts": { "arbiter": 2, "config": 1, "primary": 4, "secondary": 8, "mongos": 2 }, "id": "{PROJECT-ID}", "ldapGroupMappings" : [ { "roleName": "GROUP_OWNER", "ldapGroups": [ project-owner" ] }, ... ], "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), "links" : [], "name": "My Project", "orgId" : "111111111cccccf38dc78bdf", "publicApiEnabled": true, "replicaSetCount": 3, "shardCount": 2, "tags": [ "DEV", "PRODUCT" ] }