将部署区域分配给一个分片

在此页面上

Resource

请求参数
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

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

Resource

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

请求参数

请求路径参数

Parameter	类型	必要性	说明
PROJECT-ID	字符串	必需	唯一的 24 位十六进制数字字符串，用于标识包含具有要查找的备份配置的集群的项目。
CLUSTER-ID	字符串	必需	唯一的 24 位十六进制数字字符串，用于标识要查找其备份配置的集群。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

名称	类型	必要性	说明
`deploymentConfigs`	对象数组	必需	要为其分配部署区域的集群成员的规范对象。
`deploymentConfigs` `.rsId`	字符串	必需	标识分片的副本设立分片。
`deploymentConfigs` `.deploymentId`	字符串	必需	引用要分配给分片的部署地区的唯一分片。
`multiRegionBackupEnabled`	布尔	必需	指示是否为集群启用多区域备份的标志。

响应

名称	类型	说明
`authMechanismName`	字符串	连接到同步源数据库所需的身份验证机制。如果同步存储使用身份验证，则MongoDB Ops Manager需要此参数。 MongoDB Ops Manager返回以下内容之一： `MONGODB_CR` （涵盖 SCRAM-SHA-1、SCRAM-SHA-256 和 MONGODB-CR。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
`clusterId`	字符串	唯一的 24-十六进制数字string ，用于标识配置用于备份的集群。
`encryptionEnabled`	布尔	指示是否为备份配置启用加密的标志。
`excludedNamespaces`	字符串数组	备份中省略的数据库名称和集合名称列表。每个string指定一个 `{database}` 或 `{database}.{collection}` 形式的命名空间。
`groupId`	字符串	唯一的 24 位十六进制数字字符串，用于标识拥有此备份配置的项目。
`includedNamespaces`	字符串数组	备份中包含的数据库名称和集合名称列表。每个string指定一个 `{database}` 或 `{database}.{collection}` 形式的命名空间。不会备份未在此大量中列出的任何命名空间。
`links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`multiRegionBackupEnabled`	布尔	指示是否为集群启用多区域备份的标志。
`multiRegionMisconfigured`	布尔	指示多区域备份（如果已启用）是否处于`Misconfigured`状态的标志。该值可以是以下之一： `true` - 状态为 `Misconfigured`，并且MongoDB Ops Manager不会拍摄任何新快照，尽管MongoDB Ops Manager会不间断地持续追踪具有已分配区域的集群成员的oplog 。您必须为新的集群成员选择部署地区， MongoDB Ops Manager才能恢复为所有集群成员拍摄新快照。 `false` - 状态为`Active` 。
`preferredMember`	字符串	手动将集群成员指定为备份的首选成员。仅当使用用户界面或API 设置首选成员时，才会针对成员请求出现。
`sslEnabled`	布尔	指示是否为同步源数据库启用TLS的标志。
`statusName`	字符串	备份配置的当前（或所需）状态。可能的值为： `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
`storageEngineName`	字符串	用于备份的storage engine。可能的值为： `MEMORY_MAPPED` `WIRED_TIGER`

请求示例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/?pretty=true"
     --data '
       {
         "multiRegionBackupEnabled" : true,
         "deploymentConfigs": [
           {"rsId":"myShard_2", "deploymentId":"NY_NJ"},
         ]
       }'

响应示例

响应标头

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}

响应体

{
  "authMechanismName" : "NONE",
  "clusterId" : "{CLUSTER-ID}",
  "encryptionEnabled" : false,
  "excludedNamespaces" : [ ],
  "groupId" : "{PROJECT-ID}",
  "links" : [ ],
  "multiRegionBackupEnabled" : true,
  "multiRegionMisconfigured" : false,
  "sslEnabled" : false,
  "statusName" : "STARTED",
  "storageEngineName" : "WIRED_TIGER"
}

后退

按ID创建一个部署地区

来年

删除一个部署地区