获取所有部署地区
注意
注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/backup/backupDeployments
请求参数
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， | false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
assignmentEnabled | 布尔 | 指示是否可以将部署区域分配给备份资源的标志。 |
bqProxyEndpoint | 字符串 | |
deploymentDescription | 字符串 | 描述部署地区用途的string 。 |
id | 字符串 | 在配置中引用此部署地区的唯一标识符。 |
ingestionEndpoint | 字符串 | |
links | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
restoreEndpoint | 字符串 | 为恢复请求提供服务的MongoDB Ops Manager实例。 |
请求示例
请求正文
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments"
响应体
1 { 2 "links" : [ ], 3 "results" : [ { 4 "assignmentEnabled" : true, 5 "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217", 6 "deploymentDescription" : "Eastern US", 7 "id" : "NY_NJ", 8 "ingestionEndpoint" : "https://api-backup.mongodb.com", 9 "links" : [ ], 10 "restoreEndpoint" : "https://api-backup.mongodb.com" 11 } ], 12 "totalCount" : 1 13 }