获取所有组织
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 说明 | 默认 |
---|---|---|---|
| 整型 | 页码(从 1 开始)。 |
|
| 整型 | 每页要返回的项目数,最多 500 个。 |
|
| 布尔 | 以 prettyprint 形式 显示响应 格式。 |
|
| 布尔 | 指定是否将响应包装在信封中。 |
|
| 字符串 | 根据指定的组织名称筛选结果。 对与指定 示例,如果您指定的 | 无 |
| 布尔 | 指示响应正文是否包含已删除组织的标志。 仅当提出请求的用户具有全局角色时,Ops Manager 才会遵循此参数的值。 如果设置为 |
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个组织。
名称 | 类型 | 说明 |
---|---|---|
id | 字符串 | 组织的唯一标识符。 |
isDeleted | 布尔 | 指示组织是否已删除的标志。 |
名称 | 字符串 | 组织名称。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
请求示例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://{OPSMANAGER-HOST}/api/public/v1.0/orgs/"
响应示例
响应标头
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}
响应体
{ "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 }