将一个项目迁移到另一个组织

发布 /api/atlas/v2/groups/{groupId}:migrate

将项目从当前组织迁移到另一个组织。所有项目用户及其角色都将复制到目标组织的同一项目中。在使用 Programmatic API Keys 进行身份验证时,您必须在目标组织的组织所有者角色中包含一个组织 API 密钥,以验证对目标组织的访问权限。否则,请求用户必须在两个组织中都具有“组织所有者”角色。要使用此资源,请求的服务账户或 API 密钥必须具有“组织所有者”角色。

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

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

查询参数

  • envelope 布尔

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

    默认值为false

application/vnd.atlas.2024-05-30+json

body 必需

将项目从当前组织迁移到另一个组织。

  • destinationOrgId 字符串

    唯一的 24 位十六进制数字字符串,用于标识要将指定项目移动到的目标组织。

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

  • destinationOrgPrivateApiKey 字符串

    标识 API 密钥的私有部分的唯一字符串,用于验证对目标组织的访问权限。只有使用程序化 API 密钥进行身份验证时才需要此参数。

    授予 Atlas 的编程访问权限
  • destinationOrgPublicApiKey 字符串

    标识 API 密钥公共部分的唯一字符串,该密钥用于验证对目标组织的访问权限。只有使用程序化 API 密钥进行身份验证时才需要此参数。

    最小长度为 8,最大长度为 8

    授予 Atlas 的编程访问权限

响应

  • 200 application/vnd.atlas.2024-05-30+json

    正常

    隐藏响应属性 显示响应属性 对象
    • clusterCount integer(int64) 必需

      此项目中部署的MongoDB Cloud 集群的数量。

    • 已创建 string(date-time) 必需

      MongoDB Cloud 创建此项目的日期和时间。 此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • id 字符串

      唯一的 24-十六进制数字字符串,用于标识MongoDB Cloud项目。

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

    • 名称 字符串 必需

      人类可读标签,用于标识 MongoDB Cloud 组织中包含的项目。

      格式应符合以下模式:^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

    • orgId 字符串 必需

      唯一的 24 位十六进制数字字符串,用于标识项目所属的 MongoDB Cloud 组织。

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

    • regionUsageRestrictions 字符串

      仅适用于 Atlas for Government。

      在 Commercial Atlas 中,此字段将在请求中被拒绝,并且在响应中会缺失。

      此字段对项目中的可用区域设置限制。

      COMMERCIAL_FEDRAMP_REGIONS_ONLY:仅允许在 FedRAMP Moderate 区域中部署。

      GOV_REGIONS_ONLY:仅允许在 GovCloud 区域中部署。

      值为 COMMERCIAL_FEDRAMP_REGIONS_ONLYGOV_REGIONS_ONLY。默认值为 COMMERCIAL_FEDRAMP_REGIONS_ONLY

      外部文档
    • 标记 大量[对象]

      包含长度在 1 到 255 个字符之间的键值对的列表,用于对项目进行标记和分类。

      用于标记和分类MongoDB Cloud组织、项目或集群的键值对。示例,environment : production

      Resource Tags
      Hide tags attributes 显示标签属性 对象
      • key 字符串 必需

        定义标签集的常量。 例如, environment : production标签中的environment

        最小长度为 1,最大长度为 255

      • 字符串 必需

        属于该标签集的变量。 例如, environment : production标签中的production

        最小长度为 1,最大长度为 255

    • withDefaultAlertsSettings 布尔

      指示是否使用默认警报设置创建项目的标志。创建项目后无法更新此设置。

      默认值为true

  • 401 application/json

    未经授权。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

POST /API/Atlas/v2/groups/{groupId}: 迁移
atlas api projects migrateGroup --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.MigrateGroupApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		MigrateGroupWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \
  -d '{ <Payload> }'
请求示例
{
  "destinationOrgId": "32b6e34b3d91647abb20e7b8",
  "destinationOrgPrivateApiKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "destinationOrgPublicApiKey": "zmmrboas"
}
响应示例 (200)
{
  "clusterCount": 42,
  "created": "2025-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "name": "string",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "withDefaultAlertsSettings": true
}
响应示例 (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"
}