在一个项目中获取一个集群
检索一个项目中一个集群的详细信息。
所需角色
您可以使用任何指定角色成功调用该端点。
请求
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
PROJECT-ID | 字符串 | 项目的唯一标识符。 |
CLUSTER-ID | 字符串 | 要检索的集群的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应参数
名称 | 类型 | 说明 |
|---|---|---|
clusterName | 字符串 | 集群的显示名称。 请注意， mongod本身不允许命名集群；您可以使用 命名集群。 MongoDB Ops Manager提供此名称，您可以更新它。 对于分片集群中的副本集，集群名称是其父集群的名称。 |
groupId | 字符串 | 集群所属项目的唯一标识符。 |
id | 字符串 | 集群的唯一标识符。 |
lastHeartbeat | 日期 | ISO 格式的时间戳 最近处理来自此集群的 ping 8601的日期和时间格式（ UTC 格式）。MongoDB Ops Manager |
replicaSetName | 字符串 | 副本集设置名称。当集群的 typeName为REPLICA_SET或CONFIG_SERVER_REPLICA_SET时，Ops Manager 会返回此值。 |
shardName | 字符串 | 分片名称。 当集群的 typeName为SHARDED或REPLICA_SET为分片集群的一部分时，Ops Manager 会返回此值。 |
typeName | 字符串 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?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 "clusterName": "myRS", 3 "groupId": "5e84b94c003f2d6370004f4e", 4 "id": "5e8ba20e87d9396ca9b96bd0", 5 "lastHeartbeat": "2020-06-10T14:51:28Z", 6 "links": [ 7 { 8 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", 9 "rel": "self" 10 } 11 ], 12 "replicaSetName": "myRS", 13 "typeName": "REPLICA_SET" 14 }