組織内のすべてのプロジェクトを取得

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /orgs/{ORG-ID}/groups

Request Parameters

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

path 要素	タイプ	説明
ORG-ID	必須。	情報を取得する組織の一意の識別子。

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

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

名前	タイプ	説明	default
`pageNum`	integer	ページ番号（1 から始まる）。	`1`
`itemsPerPage`	integer	1 ページあたりに返す項目の数は最大 500 です。	`100`
`pretty`	ブール値	pretty-print で応答を表示形式。	`false`
`envelope`	ブール値	応答をエンベロープでラップするかどうかを指定します。	`false`
`name`	string	指定されたプロジェクト名に基づいて結果をフィルタリングします。指定された`name`と完全に一致する組織内のプロジェクトを、大文字と小文字を区別せずに検索します。たとえば、`project1` の `name` クエリパラメータを指定すると、 MongoDB Ops Managerは `project1` という名前のプロジェクトを返しますが、`project123` という名前のプロジェクトは返しません。	なし

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

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

応答

応答ドキュメント

応答 JSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

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

`results` embeddedDocument

各結果は 1 つのプロジェクトです。

名前	タイプ	説明
ActiveAgentCount	integer	プロジェクト内のアクティブな監視、オートメーション、バックアップの数。
hostCounts	ドキュメント	クラスターの各ホストタイプのホストタイプと数を説明します。
hostCounts.arbiter	integer	クラスター内のアービタホストの数。
hostCounts.config	integer	クラスター内のシャーディングされたクラスター構成サーバーのホスト数。
hostCounts.mongos	integer	クラスター内のmongosホストの数。
hostCounts.primary	integer	クラスター内のプライマリホストの数。
hostCounts.secondary（ホストカウント）	integer	クラスター内のセカンダリホストの数。
id	string	プロジェクトの一意の識別子。
Links	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
name	string	クラスターの名前。
orgId	string	プロジェクトの親組織の一意の識別子。
publicApiEnabled	ブール値	クラスターへの API アクセスのステータス。
replicaSetCount	integer	クラスター内のレプリカセットの数。
shardCount	integer	クラスター内のシャードの数。

リクエストの例

curl --user "{username:apiKey}" \
  --include \
  --header "Content-Type: application/json" \
  --digest GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/groups"

応答例

応答ヘッダー

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": [
    {
    }
  ],
  "results": [
    {
      "activeAgentCount": 0,
      "hostCounts": {
        "arbiter": 0,
        "config": 0,
          "mongos": 0,
        "primary": 1,
        "secondary": 2
        },
      "id": "{PROJECT-ID}",
      "links": [
        {
        }
      ],
      "name": "Production Cluster",
      "orgId": "{ORG-ID}",
      "publicApiEnabled": true,
      "replicaSetCount": 1,
      "shardCount": 0
    },
    {
      "activeAgentCount": 0,
      "hostCounts": {
        "arbiter": 0,
        "config": 0,
          "mongos": 0,
        "primary": 1,
        "secondary": 2
        },
      "id": "{PROJECT-ID}",
      "lastActiveAgent": "2017-10-26T02:39:59Z",
      "links": [
        {
        }
      ],
      "name": "Staging Cluster",
      "orgId": "{ORG-ID}",
      "publicApiEnabled": true,
      "replicaSetCount": 1,
      "shardCount": 0
    }
  ],
  "totalCount": 2
}

戻る

1 つの組織を取得

すべての組織ユーザーを取得