迁移用户数据驻留位置

将用户的数据驻留位置迁移到目标地理位置。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/security_and_compliance/v1/user_migrations
HTTP Method	POST
接口频率限制	10 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	security_and_compliance:user_migration 创建、更新用户数据迁移 security_and_compliance:user_migration:multi-geo 查询、更新员工的数据驻留地
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
user_id_type	string	是	用户 ID 类型 示例值：user_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
user_ids	string\[\]	是	迁移用户 ID 列表，ID类型必须与查询参数user_id_type的取值一致 示例值：["7064408494200487938"] 数据校验规则： - 长度范围：1 ～ 100
dest_geo	string	是	迁移目标地理位置区域，参数长度2到10字符 示例值："sg"

请求体示例

{
    "user_ids": [
        "7064408494200487938"
    ],
    "dest_geo": "sg"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ user_migrations	user_migration\[\]	用户迁移列表
└ user_id	string	用户 ID
└ dest_geo	string	目标地理位置区域
└ task_id	string	迁移任务 ID
└ status	string	用户迁移状态 可选值有： - 0: 用户迁移进行中 - 1: 用户迁移已完成 - 2: 用户迁移已取消
└ progress	int	迁移进度百分比，取值 0-100

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "user_migrations": [
            {
                "user_id": "123165707875",
                "dest_geo": "us",
                "task_id": "task_1234567890abcdef",
                "status": "1",
                "progress": 20
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1781001	Invalid request parameter	修正请求参数
403	1781002	Operator has no permission to operate data residency service	操作人没有数据驻留服务操作权限，在管理员后台为操作人开通数据驻留服务操作权限，参考: https://www.feishu.cn/hc/zh-CN/articles/360043495213
400	1781003	The tenant has not enabled the data residency service.	租户未开通数据服务，需联系技术支持开通「数据驻留服务」
400	1781004	Target geographic location is unavailable	目标地理位置不可用，请使用 Open API 「获取数据驻留地理位置列表 」获取可用的地理位置列表
400	1781005	User is already in the target geographic location	用户已经在目标地理位置，请使用 Open API 「获取数据驻留地理位置列表 」获取可用的地理位置列表
400	1781006	User is in the process of migration	用户在迁移中，请使用 Open API 「获取单个用户迁移状态 」获取当前用户迁移状态
500	1782001	Internal server error	服务器内部错误，请联系技术支持
500	1782004	System or other user is operating on the specified user	请稍后重试
400	1782005	Request failed. The number of users to be migrated exceeds the seat limit of the data residency service.	调用失败，迁移人数超过数据驻留服务席位限制。请联系技术支持，按需增购席位后重新调用