获取一个项目中的所有集群

检索一个项目中所有集群的详细信息。

所需角色

您可以使用任何指定角色成功调用该终结点。

请求

基本 URL： https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/clusters

请求路径参数

名称	类型	说明
`PROJECT-ID`	字符串	项目的唯一标识符。

请求查询参数

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

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点，`content` 对象是一个信封。Cloud Manager 将 `status` 字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

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

响应

响应参数

响应文档

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

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

`results` 嵌入式文档

每个结果都是一个集群。

名称	类型	说明
`clusterName`	字符串	集群的显示名称。请注意， `mongod`本身不允许命名集群；您可以使用命名集群。 Cloud Manager 会提供此名称，您可以进行更新。对于分片集群中的副本集，集群名称是其父集群的名称。
`groupId`	字符串	集群所属项目的唯一标识符。
`id`	字符串	集群的唯一标识符。
`lastHeartbeat`	日期	Timestamp in ISO 8601 date and time format in UTC when Cloud Manager most recently processed a ping from this cluster.
`replicaSetName`	字符串	副本集设置名称。当集群的`typeName`为`REPLICA_SET`或`CONFIG_SERVER_REPLICA_SET`时，Cloud Manager 会返回此值。
`shardName`	字符串	分片名称。当集群的`typeName`为`SHARDED`或`REPLICA_SET`为分片集群的一部分时，Cloud Manager 会返回此值。
`typeName`	字符串	集群类型。 Cloud Manager 可能会返回： `REPLICA_SET`: 副本集。 `SHARDED`: 一个分片集群，其中每个分片都是一个独立运行实例。分片均不是副本集。 `SHARDED_REPLICA_SET`: 一个包含至少一个副本集分片的分片集群。 `CONFIG_SERVER_REPLICA_SET`: 配置服务器作为副本集部署。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/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-alive

HTTP/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}

响应体

1{2  "links": [3    {4      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",5      "rel": "self"6    }7  ],8  "results": [9    {10      "clusterName": "myRS",11      "groupId": "5e84b94c003f2d6370004f4e",12      "id": "5e8ba20e87d9396ca9b96bd0",13      "lastHeartbeat": "2020-06-10T14:51:28Z",14      "links": [15        {16          "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",17          "rel": "self"18        }19      ],20      "replicaSetName": "myRS",21      "typeName": "REPLICA_SET"22    },23    {24      "clusterName": "cm-clstr-repl",25      "groupId": "5e84b94c003f2d6370004f4e",26      "id": "5e84e393395ec72bfc888f6c",27      "lastHeartbeat": "2020-06-10T15:20:08Z",28      "links": [29        {30          "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",31          "rel": "self"32        }33      ],34      "replicaSetName": "cm-clstr-repl",35      "typeName": "REPLICA_SET"36    }37  ],38  "totalCount": 239}