Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

1 つの組織を取得

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

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

GET /orgs/{ORG-ID}
path 要素
タイプ
説明
ORG-ID
string
(必須。) 情報を取得する組織の一意の識別子。

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

名前
タイプ
説明
default
pretty
ブール値
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false
includeDeletedOrgs
ブール値

レスポンス本文に削除された組織が含まれているかどうかを示すフラグ。

MongoDB Ops Manager は、リクエストを行うユーザーがグローバル ロールを持っている場合にのみ、このパラメーターの値を尊重します。

trueまたは省略に設定されている場合、グローバルロールを割り当てられたユーザーにはレスポンスに削除されたプロジェクトが含まれます。 falseに設定されている場合、またはユーザーにグローバル所有者ロールがない場合、レスポンスには削除された組織は含まれません。

true

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

名前
タイプ
説明
id
string
組織の一意の識別子です。
isDeleted
ブール値
組織が削除されたかどうかを示すフラグ。
name
string
組織名。
Links
オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"
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}
{
"id" : "{ORG-ID}",
"isDeleted": false,
"links": [{
}],
"name" : "Customer Application Support"
}

戻る

すべての組織を取得