Docs 菜单

Docs 主页 → MongoDB Ops Manager

获取一个组织

在此页面上

  • 资源
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

资源

GET /orgs/{ORG-ID}

请求路径参数

路径元素
类型
说明
ORG-ID
字符串
（必需。） 要检索其信息的组织的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称
类型
说明
默认
pretty
布尔
指示响应正文是否应采用 美观文本 的标志 格式。
false
envelope
布尔

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。 要修复此问题，请在查询中设置envelope=true 。

对于返回一个结果的端点，响应体包括：

名称
说明
status
HTTP响应代码
envelope
预期响应正文
false
includeDeletedOrgs
布尔

指示响应正文是否包含已删除组织的标志。

仅当提出请求的用户具有全局角色时，Ops Manager 才会遵循此参数的值。

如果设置为true或省略，分配有全局角色的用户会在响应中收到已删除的项目。 如果设置为false或用户不具有全局所有者角色，则响应不包含已删除的组织。

true

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称
类型
说明
id
字符串
组织的唯一标识符。
isDeleted
布尔
指示组织是否已删除的标志。
名称
字符串
组织名称。
链接
对象数组

指向子资源和/或相关资源的一个或多个链接。响应中的所有links 数组至少包含一个名为self 的链接。 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"
}
← 获取所有组织
获取组织中的所有项目 →

在此页面上