Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

获取所有组织

在此页面上

  • Resource
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例

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

GET /orgs

此端点不使用 HTTP 请求路径参数。

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

名称
类型
说明
默认
pageNum
整型
页码(从 1 开始)。
1
itemsPerPage
整型
每页要返回的项目数,最多 500 个。
100
pretty
布尔
prettyprint 形式 显示响应 格式。
false
envelope
布尔
指定是否将响应包装在信封中。
false
name
字符串

根据指定的组织名称筛选结果。 对与指定name完全匹配的组织执行不区分大小写的搜索。

示例,如果您指定的 name查询参数为 org1, MongoDB Ops Manager将返回名为 org1Org1 的组织,但不会返回名为 org123 的组织。

includeDeletedOrgs
布尔

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

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

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

true

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

响应 JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明
results
阵列
数组为results嵌入式文档部分中详细介绍的每一项包含一个对象。
links
阵列
数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
totalCount
数字
结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。

每个结果都是一个组织。

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

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://{OPSMANAGER-HOST}/api/public/v1.0/orgs/"
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" : [{
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs",
"rel" : "self"
}],
"results" : [{
"id" : "5a2add1cfd9f3cfb17053317",
"isDeleted": false,
"links": [{
"href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053317",
"rel": "self"
}],
"name" : "Internal Application Support"
},
{
"id" : "5a2add1cfd9f3cfb17053318",
"isDeleted": false,
"links": [{
"href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053318",
"rel": "self"
}],
"name" : "Customer Application Support"
},
{
"id" : "5a2add1cfd9f3cfb17053319",
"isDeleted": false,
"links": [{
"href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053319",
"rel": "self"
}],
"name" : "Research and Development"
}
],
"totalCount" : 3
}

后退

组织