返回所有可迁移的项目

获取 /api/atlas/v1.0/orgs/{orgId}/liveMigrations/availableProjects
服务账户 DigestAuth

返回可以迁移到指定组织的所有项目。

角色要求
  • 组织所有者

路径参数

  • orgId 字符串 必需

    唯一的 24-十六进制数字 string，用于标识包含项目的组织。使用 /orgs 终结点检索经过身份验证的用户访问权限检索的所有组织。

    格式应符合以下模式：^([a-f0-9]{24})$。

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false 。

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false 。

    Prettyprint

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • 部署 大量[对象] 必需

      可迁移到MongoDB Cloud 的集群列表。

      隐藏部署属性 显示部署属性 对象

      可迁移到MongoDB Atlas 的部署。

      • AgentVersion 字符串

        用于监控/管理集群的MongoDB 助手的版本。

      • clusterId 字符串

        唯一的 24 位十六进制数字字符串，用于标识集群。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • dbSizeBytes integer(int64)

        发出请求时磁盘上此数据库的大小（以字节为单位）。

      • 特征兼容性版本 字符串 必需

        此集群支持的MongoDB功能版本。

        MongoDB功能版本
      • 托管 布尔 必需

        指示自动化是否管理此集群的标志。

      • MongoDB 版本 字符串 必需

        此集群运行的MongoDB版本。

      • 名称 字符串 必需

        用于标识此集群的人类可读标签。

      • oplogSizeMB integer(int32)

        发出请求时磁盘上 Oplog 的大小（以 MB 为单位）。

      • 分片 布尔 必需

        指示是否有人将此集群配置为分片集群的标志。

        • 如果为 true，则此集群用作分片集群。
        • 如果为 false，则此集群用作副本集。
      • shardsSize integer(int32)

        组成此集群的分片数量。

      • tlsEnabled 布尔 必需

        指示是否有人为此集群启用 TLS 的标志。

    • migrationHosts array[string] 必需

      您配置用于执行迁移的MongoDB 助手列表的主机名。

    • 名称 字符串 必需

      人类可读标签，用于标识此项目。

      最小长度为 1，最大长度为 64。

    • projectId 字符串 必需

      唯一的 24-十六进制数字字符串，用于标识要迁移的项目。

      格式应符合以下模式：^([a-f0-9]{24})$。
  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串 | null

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
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) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
响应示例 (401) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
响应示例 (403) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
响应示例 (404) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
响应示例 (500) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}