获取发出请求的编程 API 密钥可用的所有项目中所有集群的详细信息。
所需角色
您可以使用任何指定角色成功调用该终结点。
请求
基本 URL： https://cloud.mongodb.com/api/public/v1.0
GET /api/public/v1.0/clusters请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式的标记。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应参数
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个项目。
名称 | 类型 | 说明 |
|---|---|---|
| 对象数组 | 描述 API 密钥有权查看的每个项目中集群的对象。 |
| 整型 | 打开的警报数量。 |
| 布尔 | 指定访问集群中的节点是否需要进行身份验证。 |
| 字符串 | 集群的可用性。 值包括：
|
| 布尔 | 指定是否为集群启用备份。 |
| 字符串 | Cloud Manager集群的唯一标识符。 |
| 数字 | 集群中每个节点上存储的数据总大小（以字节为单位）。 |
| 字符串 | Cloud Manager 中显示的集群名称。 |
| 整型 | 集群中的节点数。 |
| 布尔 | 指定访问权限集群中的节点是否需要SSL身份验证。 |
| 字符串 | |
| 字符串数组 | 集群中每个节点运行的 MongoDB 版本。 |
| 字符串 | 项目的唯一标识符。 |
| 字符串 | 返回的集群所属项目的名称。 |
| 字符串 | 拥有返回集群所属项目的组织的唯一标识符。 |
| 字符串 | 拥有返回集群所属项目的组织名称。 |
| 字符串 | 计划类型。 在Cloud Manager中，此值始终为Cloud Manager。 |
| 字符串数组 | 应用于项目的标签。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/clusters?pretty=true"响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/clusters", "rel" : "self" } ], "results" : [ { "clusters" : [ { "alertCount" : 0, "authEnabled" : true, "availability" : "available", "backupEnabled" : false, "clusterId" : "5e6bc0352e41683c191c8956", "dataSizeBytes" : 0, "name" : "Cluster1", "nodeCount" : 3, "sslEnabled" : true, "type" : "replica set", "versions" : [ "4.2.3" ] }, { "alertCount" : 0, "authEnabled" : true, "availability" : "available", "backupEnabled" : false, "clusterId" : "5e6bc60ba4c3f47a54d8fe95", "dataSizeBytes" : 0, "name" : "Cluster2", "nodeCount" : 3, "sslEnabled" : true, "type" : "replica set", "versions" : [ "4.2.3" ] } ], "groupId" : "5df90932f10fab675508b0e5", "groupName" : "az", "orgId" : "5df7a168f10fab3a149357fb", "orgName" : "jww-12-16", "planType" : "Cloud Manager", "tags" : [
] }, { "clusters" : [ { "alertCount" : 0, "authEnabled" : true, "availability" : "available", "backupEnabled" : false, "clusterId" : "5e6bbf6a9de0d35b1527dd93", "dataSizeBytes" : 0, "name" : "Cluster0", "nodeCount" : 3, "sslEnabled" : true, "type" : "replica set", "versions" : [ "4.2.3" ] } ], "groupId" : "5df90590f10fab5e33de2305", "groupName" : "jww-12-17", "orgId" : "5df7a168f10fab3a149357fb", "orgName" : "jww-12-16", "planType" : "Cloud Manager", "tags" : [
] }, { "clusters" : [ { "alertCount" : 0, "authEnabled" : true, "availability" : "dead", "backupEnabled" : false, "clusterId" : "5e6be93fd434591c4ca765f6", "dataSizeBytes" : 0, "name" : "Cluster0", "nodeCount" : 0, "sslEnabled" : true, "type" : "replica set", "versions" : [ "4.2.3" ] } ], "groupId" : "5df90923f10fab675508b065", "groupName" : "gcp", "orgId" : "5df7a168f10fab3a149357fb", "orgName" : "jww-12-16", "planType" : "Cloud Manager", "tags" : [
] } ], "totalCount" : 3}