返回组织之间的连接状态
返回指定源 Ops Manager 组织与目标 MongoDB Atlas 组织之间的连接状态。
所需角色
您的API密钥必须具有 Organization Owner
角色才能成功调用此资源。
请求
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /orgs/{orgId}/liveExport/migrationLink/status
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
orgId | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识包含要迁移到 MongoDB Atlas 的项目的源组织。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
---|---|---|
状态 | 字符串 | 该组织与 MongoDB Atlas 组织中的目标集群之间存在的连接状态。 响应返回 |
请求示例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/liveExport/migrationLink/status?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}
响应体
{ "status": "SYNCED" }