移行可能なすべてのプロジェクトを返す

GET /api/atlas/v1.0/orgs/{orgId}/liveMigrations/availableProjects

サービスアカウント DigestAuth

指定された組織に移行できるすべてのプロジェクトを返します。

path パラメータ

orgId string 必須

24プロジェクトを含む組織を識別する一意の桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリパラメータ

envelope ブール値

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。

デフォルト値はfalseです。
pretty ブール値

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

デフォルト値はfalseです。

Prettyprint

応答

200 application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- 配置 array[オブジェクト]
  
  MongoDB Cloud に移行できるクラスターのリスト。
  
  MongoDB Atlasに移行できる配置。
  
  配置属性の非表示配置属性の表示オブジェクト
  
  agentVersion string
  
  クラスターを監視/管理するMongoDB Agent のバージョン。
  
  clusterId string
  
  クラスターを識別するユニークな 24 桁の 16 進数の文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  dbSizeBytes integer(int64)
  
  リクエスト時にディスク上のこのデータベースのサイズ（バイト単位）。
  
  機能の互換性バージョン string 必須
  
  このクラスターがサポートするMongoDB機能のバージョン。
  
  MongoDB機能バージョン
  
  MANAGED ブール値必須
  
  オートメーションがこのクラスターを管理するかどうかを示すフラグ。
  
  mongoDBVersion string 必須
  
  このクラスターが実行するMongoDBのバージョン。
  
  name string 必須
  
  このクラスターを識別する、人間が判読できるラベル。
  
  oplogSizeMB integer(int32)
  
  リクエスト時にディスク上の Oplog のサイズ（MB 単位）。
  
  シャードブール値必須
  
  このクラスターがシャーディングされたクラスターとして構成されているかどうかを示すフラグ。
  
  true の場合、このクラスターはシャーディングされたクラスターとして機能します。
  
  false の場合、このクラスターはレプリカセットとして機能します。
  
  shardsSize integer(int32)
  
  このクラスターを構成するシャードの数。
  
  tlsEnabled ブール値必須
  
  このクラスターに対して TLS が有効にされているかどうかを示すフラグ。
- migrationHosts array[string]
  
  移行を実行するように構成したMongoDB Agent リストのホスト名。
- name string 必須
  
  このプロジェクトを識別する、人間に判読可能なラベル。
  
  最小長は 1、最大長は 64 です。
- projectId string 必須
  
  移行するプロジェクトを識別する一意な 24 桁の 16 進数の文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
400 application/ JSON

無効なリクエストです。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
401 application/ JSON

許可されていません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
404 application/ JSON

見つかりません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
500 application/ JSON

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。

GET /api/atlas/v1.0 /orgs/{orgId}/liveMigrations/availableProjects

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/liveMigrations/availableProjects' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

応答の例（200）

[
  {
    "deployments": [
      {
        "agentVersion": "string",
        "clusterId": "32b6e34b3d91647abb20e7b8",
        "dbSizeBytes": 8192,
        "featureCompatibilityVersion": "string",
        "managed": true,
        "mongoDBVersion": "string",
        "name": "Project X sharded cluster",
        "oplogSizeMB": 3,
        "sharded": true,
        "shardsSize": 3,
        "tlsEnabled": true
      }
    ],
    "migrationHosts": [
      "string"
    ],
    "name": "string",
    "projectId": "32b6e34b3d91647abb20e7b8"
  }
]

応答の例（400）

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

応答の例（401）

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

応答の例（403）

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

応答の例（404）

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

応答の例（500）

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

移行可能なすべてのプロジェクトを返す

path パラメータ

クエリ パラメータ

応答

クエリパラメータ