1 つの組織と 1 つの Atlas 組織の接続
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
ソース Cloud Manager 組織をターゲットの MongoDB Atlas 組織に接続します。
必須のロール
このリソースを正常に呼び出すには、API キーに Organization Owner
ロールが必要です。
リクエスト
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
POST /orgs/{orgId}/liveExport/migrationLink
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
orgId | string | 必須 | プロジェクトを含むソース組織を識別する一意の 24 桁の 16 進数string 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
linkToken | string | 必須 | またはstring の配置からMongoDB Cloud Manager MongoDB Ops ManagerMongoDB Atlasのクラスターへのライブ移行中に、 またはMongoDB Cloud ManagerMongoDB Ops Manager から に接続するために必要な情報を含むMongoDB Atlas 。 MongoDB Cloud ManagerまたはMongoDB Ops Managerの配置からデータを移行する場合は、次の操作を行う必要があります。
同じトークンリンクを使用して、 MongoDB Cloud ManagerまたはMongoDB Ops Manager組織内の各配置を 1 つずつ順番に移行します。 MongoDB Atlas では複数のトークンリンクを生成できます。 MongoDB Cloud ManagerまたはMongoDB Ops Managerの組織ごとに、1 つの固有のトークンリンクを使用します。 |
応答
名前 | タイプ | 説明 |
---|---|---|
状態 | string | この組織と 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" }