连接一个组织与一个 Atlas 组织
将源 Cloud Manager 组织与目标 MongoDB Atlas 组织连接。
所需角色
您的 API 密钥必须具有 Organization Owner
角色才能成功调用此资源。
请求
基本 URL: https://cloud.mongodb.com/api/public/v 1.0
POST /orgs/{orgId}/liveExport/migrationLink
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
orgId | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识包含项目的源组织。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
linkToken | 字符串 | 必需 | 包含在从 MongoDB Cloud Manager 或 Ops Manager 部署实时迁移到 MongoDB Atlas 集群期间从 MongoDB Cloud Manager 或 Ops Manager 连接到 MongoDB Atlas 所需信息的字符串。 当您从 MongoDB Cloud Manager 或 Ops Manager 部署迁移数据时,需要执行以下操作:
您可以使用相同的链接令牌(Link-Token)按顺序迁移 MongoDB Cloud Manager 或 Ops Manager 组织中的每个部署,一次一个。您可以在 MongoDB Atlas 中生成多个链接令牌(Link-Token)。为每个 MongoDB Cloud Manager 或 Ops Manager 组织使用一个唯一的链接令牌(Link-Token)。 |
响应
名称 | 类型 | 说明 |
---|---|---|
状态 | 字符串 | 该组织与 MongoDB Atlas 组织中的目标集群之间存在的连接状态。 响应返回 |
请求示例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/{orgId}/liveExport/migrationLink?pretty=true' \ --data '{ "linkToken": "string" }'
响应示例
响应标头
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
201 Created 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}
响应体
{ "status": "SYNCED" }