更新一个集群

更新一个项目中的一个集群。

您只能更新clusterName字段。 MongoDB Ops Manager根据其发现的集群属性填充所有其他集群字段。

注意

此操作仅适用于typeName为SHARDED或SHARDED_REPLICA_SET的集群。

所需角色

您可以使用以下任何分配的角色成功调用此端点：

请求

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}

请求路径参数

名称	类型	说明
`PROJECT-ID`	字符串	项目的唯一标识符。
`CLUSTER-ID`	字符串	要检索的集群的唯一标识符。

请求查询参数

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

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用 pretty-print 格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

正文参数	类型	必要性	说明
`clusterName`	字符串	必需	要分配给集群的名称。

响应

响应参数

名称	类型	说明
`clusterName`	字符串	Display name of the cluster. Note that `mongod` itself doesn't allow you to name a cluster; Ops Manager supplies this name and you can update it. For a replica set within a sharded cluster, the cluster name is the name of its parent cluster.
`groupId`	字符串	集群所属项目的唯一标识符。
`id`	字符串	集群的唯一标识符。
`lastHeartbeat`	日期	Ops Manager最近一次处理来自此集群的网络探测（ping）时，采用 ISO 8601 日期和时间格式（以 UTC 表示）的时间戳。
`replicaSetName`	字符串	副本集设置名称。当集群的`typeName`为`REPLICA_SET`或`CONFIG_SERVER_REPLICA_SET`时，Ops Manager 会返回此值。
`shardName`	字符串	分片名称。当集群的`typeName`为`SHARDED`或`REPLICA_SET`为分片集群的一部分时，Ops Manager 会返回此值。
`typeName`	字符串	集群类型。 Ops Manager 可能会返回： `REPLICA_SET`: A replica set. `SHARDED`: A sharded cluster where each shard is a standalone instance. No shards are replica sets. `SHARDED_REPLICA_SET`: 一个包含至少一个副本集分片的分片集群。 `CONFIG_SERVER_REPLICA_SET`: 配置服务器作为副本集部署。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true"
     --data '{
        "clusterName":"New Cluster Name"
       }'

响应示例

响应标头

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

HTTP/1.1 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": "New Cluster Name",
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 }

1	{
2	"clusterName": "New Cluster Name",
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	}