获取所有项目中的所有集群
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
获取发出请求的编程 API 密钥可用的所有项目中所有集群的详细信息。
所需角色
您可以使用任何指定角色成功调用该端点。
请求
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /api/public/v1.0/clusters
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应参数
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个项目。
名称 | 类型 | 说明 |
---|---|---|
clusters | 对象数组 | 描述 API 密钥有权查看的每个项目中集群的对象。 |
clusters.[n].alertCount | 整型 | 打开的警报数量。 |
clusters.[n].authEnabled | 布尔 | 指定访问集群中的节点是否需要进行身份验证。 |
clusters.[n].availability | 字符串 | 集群的可用性。 值包括:
|
clusters.[n].backupEnabled | 布尔 | 指定是否为集群启用备份。 |
clusters.[n].clusterId | 字符串 | MongoDB Ops Manager集群的唯一标识符。 |
clusters.[n].dataSizeBytes | 数字 | 集群中每个节点上存储的数据总大小(以字节为单位)。 |
clusters.[n].name | 字符串 | MongoDB Ops Manager中显示的集群名称。 |
clusters.[n].nodeCount | 整型 | 集群中的节点数。 |
clusters.[n].sslEnabled | 布尔 | 指定访问集群中的节点是否需要SSL身份验证。 |
clusters.[n].type | 字符串 | |
clusters.[n].versions | 字符串数组 | 集群中每个节点运行的 MongoDB 版本。 |
groupId | 字符串 | 项目的唯一标识符。 |
groupName | 字符串 | 返回的集群所属项目的名称。 |
orgId | 字符串 | 拥有返回集群所属项目的组织的唯一标识符。 |
orgName | 字符串 | 拥有返回集群所属项目的组织名称。 |
planType | 字符串 | 计划类型。 在MongoDB Ops Manager中,此值始终为MongoDB Ops Manager 。 |
tags | 字符串数组 | 应用于项目的标签。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/clusters?pretty=true"
响应示例
响应标头
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}
响应体
1 { 2 "links": [ 3 { 4 "href": "https://example.com:8080/api/public/v1.0/clusters", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "clusters": [ 11 { 12 "alertCount": 0, 13 "authEnabled": true, 14 "availability": "available", 15 "backupEnabled": false, 16 "clusterId": "5e6bc0352e41683c191c8956", 17 "dataSizeBytes": 0, 18 "name": "Cluster1", 19 "nodeCount": 3, 20 "sslEnabled": true, 21 "type": "replica set", 22 "versions": [ 23 "4.2.3" 24 ] 25 }, 26 { 27 "alertCount": 0, 28 "authEnabled": true, 29 "availability": "available", 30 "backupEnabled": false, 31 "clusterId": "5e6bc60ba4c3f47a54d8fe95", 32 "dataSizeBytes": 0, 33 "name": "Cluster2", 34 "nodeCount": 3, 35 "sslEnabled": true, 36 "type": "replica set", 37 "versions": [ 38 "4.2.3" 39 ] 40 } 41 ], 42 "groupId": "5df90932f10fab675508b0e5", 43 "groupName": "az", 44 "orgId": "5df7a168f10fab3a149357fb", 45 "orgName": "jww-12-16", 46 "planType": "Ops Manager", 47 "tags": [ 48 49 ] 50 }, 51 { 52 "clusters": [ 53 { 54 "alertCount": 0, 55 "authEnabled": true, 56 "availability": "available", 57 "backupEnabled": false, 58 "clusterId": "5e6bbf6a9de0d35b1527dd93", 59 "dataSizeBytes": 0, 60 "name": "Cluster0", 61 "nodeCount": 3, 62 "sslEnabled": true, 63 "type": "replica set", 64 "versions": [ 65 "4.2.3" 66 ] 67 } 68 ], 69 "groupId": "5df90590f10fab5e33de2305", 70 "groupName": "jww-12-17", 71 "orgId": "5df7a168f10fab3a149357fb", 72 "orgName": "jww-12-16", 73 "planType": "Ops Manager", 74 "tags": [ 75 76 ] 77 }, 78 { 79 "clusters": [ 80 { 81 "alertCount": 0, 82 "authEnabled": true, 83 "availability": "dead", 84 "backupEnabled": false, 85 "clusterId": "5e6be93fd434591c4ca765f6", 86 "dataSizeBytes": 0, 87 "name": "Cluster0", 88 "nodeCount": 0, 89 "sslEnabled": true, 90 "type": "replica set", 91 "versions": [ 92 "4.2.3" 93 ] 94 } 95 ], 96 "groupId": "5df90923f10fab675508b065", 97 "groupName": "gcp", 98 "orgId": "5df7a168f10fab3a149357fb", 99 "orgName": "jww-12-16", 100 "planType": "Ops Manager", 101 "tags": [ 102 103 ] 104 } 105 ], 106 "totalCount": 3 107 }