华为云用户手册

示例流程 图1 给用户授予CBH权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予云堡垒机的只读权限“CBH ReadOnlyAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择云堡垒机，进入CBH实例主界面，单击“购买云堡垒机服务”，尝试购买CBH实例，若提示权限不足，无法购买CBH实例（假设当前权限仅包含“CBH ReadOnlyAccess”），表示“CBH ReadOnlyAccess”生效。 在“服务列表”中选择除云堡垒机外（假设当前策略仅包含“CBH ReadOnlyAccess”）的任一服务，若提示权限不足，表示“CBH ReadOnlyAccess”已生效。

场景二：不同域名对应的网站，检测配额独立计算 举例：某官网（http://www.example.com）是一个网站，该网站下有链接到运营商BG（https://carrier.example.com/）、企业BG（https://e.example.com/）、消费者BG（https://consumer.example.com/）三个网站，三个网站对应三个不同的域名，则占4个检测网站配额，即在购买内容安全检测服务时，“检测对象类型”选择“网站”，“检测对象”配置如图1所示。 图1 检测对象配置

场景三：域名相同但网站名称不同，检测配额独立计算 举例：某省省法院官网（https://www.example.com/index.html），市法院官网（https://www.example.com/test.html），虽然属于同一个域名，但官网名称不同，则判定为2个网站，占2个检测网站配额，即在购买内容安全检测服务时，“检测对象类型”选择“网站”，“检测对象”配置如图2所示。 图2 网站配置

购买内容安全检测服务后，什么时候扣费？ 购买内容安全检测服务后，系统立即执行检测并扣费，且检测过程中，不支持修改检测域名、暂停任务、退费等操作。 内容安全检测服务支持三种检测类型：内容安全单次检测（按需）、文本安全监测（按月）、文本安全监测（按年）。选择“内容安全单次检测（按需）”时，内容安全检测服务按“检测对象”的总个数进行收费。同一个对象再次进行扫描时，需要重新收费。网站检测配额请参见购买内容安全检测服务时，如何确定网站检测配额？。 例如：单次配置了10个检测对象（新媒体账号或网站网址），每个检测对象检测一次，则需要进行10次收费。 详细的计费说明请参见计费项。 父主题： 内容安全检测服务

API限制 数字内容生产线服务对服务端API设置了调用次数限制，避免出现短时间内重复调用API，服务中断的情况。 表2 API流控限制 接口分类 接口名称 单租户接口流控 接口总体流控 数字资产管理 创建资产 1次/秒 10次/秒 更新资产 1次/秒 10次/秒 删除资产 2次/秒 20次/秒 查询资产列表 20次/秒 200次/秒 查询资产详情 10次/秒 100次/秒 恢复被删除的资产 1次/秒 10次/秒 查询资产概要 20次/秒 200次/秒 文件管理 创建文件并获取上传URL 1次/秒 10次/秒 删除文件 1次/秒 10次/秒 确认文件已上传 1次/秒 10次/秒 数字人风格管理 查询数字人风格列表 10次/秒 100次/秒 风格化照片建模 创建照片建模任务 1次/秒 10次/秒 照片建模任务列表查询 1次/秒 10次/秒 照片建模任务详情查询 1次/秒 10次/秒 基于图片URL创建照片建模任务 2次/秒 10次/秒 语音驱动 创建语音驱动任务 1次/秒 10次/秒 获取语音驱动任务列表 20次/秒 200次/秒 获取语音驱动数据 20次/秒 200次/秒 视频驱动 创建视频驱动任务 1次/秒 10次/秒 查询视频驱动任务列表 20次/秒 200次/秒 查询视频驱动任务详情 20次/秒 200次/秒 停止视频驱动任务 1次/秒 10次/秒 控制数字人驱动 1次/秒 10次/秒 视频制作剧本管理 创建视频制作剧本 1次/秒 10次/秒 查询视频制作剧本列表 20次/秒 200次/秒 查询视频制作剧本详情 20次/秒 200次/秒 更新视频制作剧本 1次/秒 10次/秒 删除视频制作剧本 2次/秒 20次/秒 分身数字人视频制作管理 创建分身数字人视频制作任务 1次/秒 10次/秒 查询分身数字人视频制作任务详情 20次/秒 200次/秒 取消等待中的分身数字人视频制作任务 1次/秒 10次/秒 创建照片分身数字人视频制作任务 1次/秒 10次/秒 查询照片分身数字人视频制作任务详情 20次/秒 200次/秒 取消等待中的照片分身数字人视频制作任务 1次/秒 10次/秒 数字人名片制作管理 创建数字人名片制作 1次/秒 10次/秒 查询数字人名片制作任务列表 20次/秒 200次/秒 查询数字人名片制作任务详情 20次/秒 200次/秒 更新数字人名片制作 1次/秒 10次/秒 删除数字人名片制作任务 2次/秒 20次/秒 智能直播间管理 创建智能直播间 1次/秒 10次/秒 查询智能直播间列表 20次/秒 200次/秒 查询智能直播剧本详情 20次/秒 200次/秒 更新智能直播间信息 1次/秒 10次/秒 删除智能直播间 2次/秒 20次/秒 直播任务管理 启动数字人智能直播任务 1次/秒 10次/秒 查询数字人智能直播任务列表 20次/秒 200次/秒 查询数字人智能直播任务详情 20次/秒 200次/秒 结束数字人智能直播任务 1次/秒 10次/秒 控制数字人直播过程 1次/秒 10次/秒 上报直播间事件 1次/秒 10次/秒

计费模式 数字内容生产线提供按需、包年/包月两种计费模式。 按需计费模式：包含按需和按需套餐包两种计费方式。 按需计费：一种后付费模式，即先使用再付费。每个计费周期分别统计各资源的实际使用量，并根据使用量*单价的方式计算出费用，然后从账户余额中扣除对应金额。 按需套餐包：您也可以通过按需套餐包的方式，提前购买使用额度，获取更多的优惠。套餐包需要在有效期内使用，且超出套餐包的部分自动转按需计费。 包年/包月计费模式：一种预付费模式，即先付费再使用，按照订单的购买周期进行结算。购买周期越长，享受的折扣越大。

到期与欠费 欠费：套餐包没有欠费概念，按需付费是根据每个计费项在对应的计费周期进行扣费的，若余额不足，则无法对上一个计费周期进行扣费，从而导致数字内容生产线服务欠费。数字内容生产线服务欠费后有一个保留期。在续费后解冻，可以继续正常使用数字内容生产线服务，请注意在保留期内进行续费。华为云会将根据您的客户等级来定义云服务资源保留期时长。请在基本信息页面查看您的客户等级，更多欠费停服处理规则请参见保留期。 服务到期：按需付费没有到期概念。每个套餐包都有效期，套餐包到期后，若仍有额度将一次性清零，后续产生的费用将从账户余额中扣除。

计费项 数字内容生产线的费用可以分为照片建模、语音驱动、视觉驱动和资产基础管理费用四类，具体说明如下表所示。具体价格说明请参见产品价格详情。 表1 计费组成 类别 计费项 计费量纲 计费说明 付费方式 照片建模 风格化单照片建模 次 输入单张真人照片自动生成3D风格化基础模型时，按调用接口次数计费。 按需计费 风格化单照片建模免费试用套餐包 个 输入单张真人照片自动生成3D风格化基础模型时，按调用接口次数计费。 最高免费调用接口1000次，有效期3个月。 按需套餐包 风格化单照片建模10000次套餐包 个 输入单张真人照片自动生成3D风格化基础模型时，按调用接口次数计费。 最高可调用接口10000次，有效期6个月。 按需套餐包 语音驱动 语音驱动时长 分钟 输入文本或语音来驱动数字人的口型、表情等行为时，按已生成的驱动数据时长计费。 按需计费 语音驱动免费使用套餐包 个 输入文本或语音来驱动数字人的口型、表情等行为时，按已生成的驱动数据时长计费。 免费驱动数据时长1小时，有效期1个月。 按需套餐包 语音驱动10小时套餐包 个 输入文本或语音来驱动数字人的口型、表情等行为时，按已生成的驱动数据时长计费。 免费驱动数据时长10小时，有效期3个月。 按需套餐包 语音驱动100小时套餐包 个 输入文本或语音来驱动数字人的口型、表情等行为时，按已生成的驱动数据时长计费。 免费驱动数据时长100小时，有效期6个月。 按需套餐包 语音驱动500小时套餐包 个 输入文本或语音来驱动数字人的口型、表情等行为时，按已生成的驱动数据时长计费。 免费驱动数据时长500小时，有效期12个月。 按需套餐包 视觉驱动 单目视觉驱动路数 路 使用单目摄像头采集真实人运动数据来驱动数字人运动时，按已生成的驱动视觉时长计费。 输出数字人表情、肢体、手势等动作数据，按路收费。 包月 单目视觉驱动时长 分钟 使用单目摄像头采集真实人运动数据来驱动数字人运动时，按已生成的驱动视觉时长计费。 按需计费 单目视觉驱动免费试用套餐包 个 使用单目摄像头采集真实人运动数据来驱动数字人运动时，按已生成的驱动视觉时长计费。 免费输出1小时数字人表情、肢体、手势等动作数据，有效期1个月。 按需套餐包 资产基础管理 数字资产管理基础版 个 提供数字资产的存储、简单分类、搜索等基础管理能力。 其中，数据资产存储大小不超过1TB。 包年/包月

实例规格类型与公网/私网负载均衡器的对应关系 表1 独享型负载均衡与公网/私网负载均衡器的对应关系 实例规格类型 网络类型 对应关系 独享型负载均衡 IPv4公网 ELB绑定弹性公网IP，支持IPv4公网流量请求，称为公网负载均衡器。 IPv4私网 ELB绑定私网IP，支持IPv4私网流量请求，称为私网负载均衡器。 IPv6公网私网 既支持IPv6公网请求又支持IPv6私网请求。 ELB绑定弹性公网IP，支持IPv6公网流量请求，称为公网负载均衡器。 ELB绑定私网IP，支持IPv6私网流量请求，称为私网负载均衡器。 表2 共享型负载均衡与公网/私网负载均衡器的对应关系 实例规格类型 网络类型 对应关系 共享型负载均衡 IPv4公网 ELB绑定弹性公网IP，支持公网流量请求，称为公网负载均衡器。 IPv4私网 ELB绑定私网IP，支持私网流量请求，称为私网负载均衡器。 说明： 共享型负载均衡默认支持IPv4私网，且不支持修改。

入网流量路径 对于入网流量，负载均衡会根据用户配置的流量分配策略，对来自公网或者私网的访问请求进行转发和处理。如图1所示。 图1 入网流量路径 当负载均衡器使用四层协议TCP/UDP时： 四层协议TCP/UDP的流量只经过LVS集群进行转发。 LVS集群的所有节点会根据负载均衡器的流量分配策略，将接收到的访问请求直接分发到后端服务器。 当负载均衡器使用七层协议HTTP/HTTPS时： 七层协议HTTP/HTTPS的流量，需要经过LVS集群先将访问请求平均分发到Nginx集群的所有节点，然后Nginx集群的节点再根据负载均衡器的转发策略，将接收到的请求最终分发到后端服务器。 七层协议HTTPS的流量，在最终分发到服务器前，还需要在Nginx集群内进行证书验证以及数据包的解密操作。然后通过HTTP协议将请求分发到后端服务器。

出网流量路径 出网流量遵循请求从哪进来，响应从哪出去的原则。如出网流量路径所示。 图2 出网流量路径 通过负载均衡器进入的访问流量，对应的响应流量通过负载均衡器返回。 由于负载均衡器实际是通过绑定的EIP接收来自公网的流量和响应请求，所以负载均衡器的限制实际是在负载均衡器绑定的EIP 上，并在EIP上进行计费。从负载均衡到后端云服务器之间通过VPC内网进行通信，不收取费用。 通过NAT网关进入的访问流量，对应的响应流量通过NAT网关返回。在NAT网关上限速和计费。 由于NAT网关实际是通过绑定的EIP接收来自公网的流量和访问公网，所以NAT网关上进行的是连接数的限制，带宽或者流量的限制是在NAT网关绑定的EIP上，并分别在NAT网关和弹性公网IP上进行计费。 通过EIP进入的访问流量，对应的响应流量通过EIP返回，在EIP上限速和计费。

使用ELB和AS为潮汐业务弹性分发流量 对于存在潮汐效应的业务，结合弹性伸缩服务，随着业务量的增长和收缩，弹性伸缩服务自动增加或者减少的ECS实例，可以自动添加到ELB的后端服务器组或者从ELB的后端服务器组移除。负载均衡实例会根据流量分发、健康检查等策略灵活使用ECS实例资源，在资源弹性的基础上大大提高资源可用性，如图2所示。例如电商的“双11”、“双12”、“618”等大型促销活动，业务的访问量短时间迅速增长，且只持续短暂的几天甚至几小时。使用负载均衡及弹性伸缩能最大限度的节省IT成本。 图2 灵活扩展

裸金属服务器与其他服务的关系 表1 裸金属服务器与其他服务的关系 服务名称 裸金属服务器与其他服务的关系 主要交互功能/最佳实践 镜像服务（Image Management Service，IMS） 您可以通过镜像创建裸金属服务器，提高裸金属服务器的部署效率；也可以将裸金属服务器转换为私有镜像，供您个人使用，或者共享给他人。 通过私有镜像创建裸金属服务器 通过裸金属服务器创建私有镜像 通过外部镜像文件创建私有镜像 虚拟私有云（Virtual Private Cloud，VPC） 为裸金属服务器提供一个逻辑上完全隔离的专有网络，您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性。用户可以通过VPC方便地管理、配置内部网络，进行安全、快捷的网络变更。同时，用户可以自定义安全组内与组间裸金属服务器的访问规则，加强裸金属服务器的安全保护。 添加安全组规则 绑定弹性公网IP至服务器 专属云（Dedicated Cloud，DeC） 专属云中的专属资源池与公共资源池物理隔离，如果您的业务对安全合规性有较高要求，那么您可以选择将裸金属服务器创建在专属云中。创建专属裸金属服务器有两种方式： 在专属云控制台创建专属裸金属服务器。 在云服务器控制台创建专属裸金属服务器。 开通专属云 创建专属裸金属服务器 云硬盘（Elastic Volume Service，EVS） 可以将云硬盘挂载至裸金属服务器，并可以随时扩容云硬盘容量。 挂载数据盘 初始化数据盘 卸载数据盘 扩容磁盘 专属企业存储服务（Dedicated Enterprise Storage Service，DESS） 如果您希望拥有独享、稳定时延的存储设备，以支撑Oracle RAC，SAP HANA TDI等关键应用，那么您可以在开通专属计算集群后申请专属企业存储，该存储采用华为OceanStor企业存储设备，为专属计算集群内的裸金属服务器提供块存储资源。 申请专属企业存储 创建磁盘 挂载磁盘 专属分布式存储服务（Dedicated Distributed Storage Service，DSS） 专属分布式存储服务为您提供独享的物理存储资源，通过数据冗余和缓存加速等多项技术，提供高可用性和持久性，以及稳定的低时延性能，适用于HPC、OLAP以及混合负载等应用场景。 磁盘类型概述 云服务器备份（Cloud Server Backup Service，CSBS） 云服务器备份提供对服务器的备份保护，支持基于多块云硬盘一致性快照技术的备份服务，并支持利用备份数据恢复服务器数据，最大限度保障用户数据的安全性和正确性，确保业务安全。 备份裸金属服务器 云监控服务（Cloud Eye） 当您申请裸金属服务器后，安装Agent插件并完成相关配置，即可在云监控服务查看裸金属服务器的监控数据，还可以获取可视化监控图表。 主机监控概述 支持的监控指标 云审计服务（Cloud Trace Service，CTS） 通过云审计服务，您可以记录与裸金属服务器相关的操作事件，便于日后的查询、审计和回溯。 查看审计日志 支持审计的关键操作列表 标签管理服务（Tag Management Service，TMS） 使用标签来标识裸金属服务器，便于分类和搜索。 添加标签 使用标签检索资源 删除标签

升级AOSP版本 方法一（保留用户数据） 云手机重启接口支持切换AOSP镜像版本，同时保留用户数据，操作详情请参考重启云手机实例。 注意： 重启接口支持将低版本镜像升级成高版本，但不支持将高版本镜像降级为低版本。 如果您没有保留用户数据的强烈诉求，推荐您使用方法二切换AOSP版本，应用不兼容的风险更小。 方法二（不保留用户数据） 云手机重置接口支持切换AOSP镜像版本，操作详情请参考重置云手机实例。 注意： 如“前提条件”所述，重置接口仅手机镜像为AOSP7的服务器支持切换AOSP镜像版本。进行AOSP版本升级与回退。

修订记录 版本日期 变更说明 2023-10-31 第八次正式发布。 新增云手机AOSP版本切换章节。 2023-07-31 第七次正式发布。 更新创建云手机服务器章节中参数实例规格的样例。 更新购买支持共享应用的云手机服务器章节。 更新国内云手机服务器导流海外章节中约束与限制的描述。 2023-03-31 第六次正式发布。 新增委托CPH操作OBS桶章节。 下线“读取OBS桶数据资源”、“向OBS桶上传数据资源”章节。 2022-11-23 第五次正式发布。 新增云手机共享应用管理最佳实践章节。 2022-09-05 第四次正式发布。 新增： 云手机内管理程序保活方案章节。 国内云手机服务器导流海外章节。 2021-09-01 第三次正式发布。 新增通过STF批量管理云手机章节。 2020-02-18 第二次正式发布。 调整大纲结构，优化全文内容。 2019-08-30 第一次正式发布。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 all_counts Integer 总数。 results Array of objects 迁移用户信息。 详情请参见表8 表8 results字段数据结构说明 参数 参数类型 描述 job_id String 任务ID。 is_global_password String 是否使用全局密码。 message String 错误码。 user_list Array of objects 用户列表数据。 详情请参见表9。 roles_list Array of objects 角色列表数据。 详情请参见表10。 is_success Boolean 是否成功。 表9 user_list字段数据结构说明 参数 参数类型 描述 id String 用户账号ID。 account String 账号。 comment String 说明。 is_transfer Boolean 是否迁移。 privileges Array of strings 权限。 password String 密码。 roles Array of strings 拥有的角色。 selected Boolean 是否选择。 no_privileges String 无法同步的用户权限。 parent_account String 父用户。 no_parent_account String 无法同步父子关系的父用户。 表10 roles_list字段数据结构说明 参数 参数类型 描述 role String 角色。 comment String 说明。 is_transfer Boolean 是否迁移。 privileges String 权限。 inherits_roles Array of strings 继承的角色。 selected Boolean 是否选择。

请求示例 指定任务设置需要迁移的用户 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-update-user { "jobs": [{ "is_migrate_user": true, "is_set_password": false, "job_id": "36c368d7-c03f-46e1-839a-b5c5bddjb105", "list": [{ "account": "admin.testuser2", "comment": "", "id": "admin.testuser2", "is_set_password": true, "is_transfer": true, "password": null, "privileges": null, "roles": ["admin.clusterAdmin"], "selected": true }], "password": "", "user_roles": [{ "comment": "", "inherits_roles": [ "admin.roletest1", "admin.roletest3", "fastunit.roletest1" ], "is_transfer": true, "privileges": "[{u'resource': {u'cluster': True}, u'actions': [u'addShard']}, {u'resource': {u'db': u'fastunit', u'collection': u'coll'}, u'actions': [u'find', u'insert', u'remove', u'update']}, {u'resource': {u'db': u'mgo', u'collection': u'mycollection3'}, u'actions': [u'insert', u'remove', u'update']}, {u'resource': {u'db': u'', u'collection': u''}, u'actions': [u'find']}, {u'resource': {u'db': u'admin', u'collection': u''}, u'actions': [u'find']}]", "role": "admin.roletest4", "selected": true }] }] } 指定任务设置不迁移用户 https://{endpoint}/v3/0549a6a31000d4e82fd1c00c3d6f2d76/jobs/batch-update-user { "jobs" : [ { "is_migrate_user" : false, "is_set_password" : false, "job_id" : "a281f62f-4631-45d6-a2d3-679a9f4jb105" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of objects 批量更新迁移用户请求列表。 详情请参见表4。 表4 jobs字段数据结构说明 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 password 否 String 全局密码。 list 否 Array of objects 用户迁移信息，迁移用户时必填。 详情请参见表5。 user_roles 否 Array of objects 角色迁移信息，迁移用户时必填。 详情请参见表6。 is_set_password 是 Boolean 是否设置密码。 is_migrate_user 是 Boolean 是否迁移用户。 is_sync_object_privilege 否 Boolean 是否同步权限，不填默认为false，PostgreSQL同步使用。 表5 list字段数据结构说明 名称 是否必选 参数类型 说明 id 是 String 用户ID。 account 是 String 用户。 comment 否 String 说明。 is_transfer 是 Boolean 是否支持迁移。 privileges 否 String 权限列表。 password 否 String 密码。 is_set_password 否 Boolean 是否重置密码。 roles 是 Array of strings 角色。 selected 是 Boolean 是否选择。 表6 user_roles字段数据结构说明 名称 是否必选 参数类型 说明 role 是 String 角色。 comment 否 String 说明。 is_transfer 是 Boolean 是否支持迁移。 privileges 是 String 权限。 inherits_roles 否 Array of strings 继承角色列表。 selected 否 Boolean 是否选择，不填默认不迁移。

支持的授权项 细粒度策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。

错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表1 v3接口错误码 状态码 错误码 错误信息 描述 处理措施 422 DRS.M00002 The returned result is empty. 服务返回结果为空。 请检查请求参数或者任务状态。 422 DRS.M00004 Service is abnormal. Check logs. 服务异常，需要查看日志。 服务异常，请联系技术人员处理。 400 DRS.M00007 Invalid request parameter. 请求参数非法。 请检查请求参数。 403 DRS.M00100 Invalid token. IAM鉴权不合法。 请检查请求的用户token信息。 404 DRS.M00101 The user role is empty. 用户角色为空。 请检查用户拥有的角色信息。 403 DRS.M00102 You do not have sufficient permissions. 用户权限不足。 请检查当前用户的DRS权限。 401 DRS.M00103 You do not have operation permissions. Check account permissions on IAM. 当前用户没有操作权限，请通过IAM检查账号权限。 请检查当前用户的DRS权限。 400 DRS.M00105 User restricted. 用户受限。 请检查当前用户的DRS权限。 400 DRS.M00200 Parameter error. 参数错误。 请检查请求参数。 400 DRS.M00201 The parameter %s is empty. %s 参数为空。 请检查请求参数。 400 DRS.M00202 The value of parameter %s is invalid. %s 取值不合法。 请检查请求参数。 400 DRS.M00210 The value of Page is invalid, %s 无效的Page值，%s。 请检查请求的page参数。 400 DRS.M00211 The value of Page exceeds the upper limit. Page超过上限。 请检查请求的page参数。 403 DRS.M00261 Invalid project ID. 无效的项目ID。 请检查请求参数project ID。 400 DRS.M00269 The tag key must be unique. 标签键不能重复。 请检查请求参数中的标签键值。 400 DRS.M00270 The tag key or value is too long. 标签键或值过长。 请检查请求参数中标签键或值的长度。 400 DRS.M00271 The number of tags exceeds the limit. 标签个数超过限制。 请检查请求参数中的标签个数。 400 DRS.M00273 Invalid parameter. The parameter contains %s. 参数不合法，参数中存在%s。 请检查请求参数。 422 DRS.M00277 The task name already exists. 该任务名称已存在。 请更换任务名称。 400 DRS.M00298 Job does not exist, please check job id. 任务不存在，请检查任务id是否正确。 请检查请求参数。 400 DRS.M00299 Only one jobId is allowed. 只允许传入一个jobID。 请检查请求参数。 400 DRS.M00300 Invalid request, %s 请求无效，%s。 请检查请求参数。 400 DRS.M00301 There are duplicate %s in request. 请求里有重复的任务ID。 请检查请求参数。 400 DRS.M00302 The transfer schema is invalid, please refer to supported transfer schema. 迁移方案无效，请参考支持的方案。 请检查请求参数。 400 DRS.M00303 The corresponding parameter is not obtained from the cache. 未从缓存中获取对应参数。 请检查请求参数。 400 DRS.M00304 This API cannot be called in the current task status. 当前任务状态不能调用此API。 请检查当前任务状态。 400 DRS.M00305 Parameter error:%s 参数错误：%s。 请检查请求参数。 400 DRS.M00306 Start time can not same with end time. 开始时间不能与结束时间相同。 请检查请求参数。 400 DRS.M00307 Only subtasks can invoke this interface. 只有子任务能用该接口。 请更换任务ID。 400 DRS.M00308 Only parent tasks can invoke this interface. 只有父任务能用该接口。 请更换任务ID。 400 DRS.M00401 %s is not support re-editing of synchronization tasks. %s 不支持重新编辑同步任务。 请更换任务ID。 400 DRS.M00402 The edit subtask already exists in the task. 子任务已存在。 请更换任务ID。 400 DRS.M00403 The job is not support modify the speed limit. 该任务不支持限速。 请更换任务ID。 422 DRS.M00414 The value for Logical Copy Slot Advance Interval must be between 1 and 999. 逻辑复制槽推进间隔的值必须在1到999之间。 请修改逻辑复制槽推进间隔的值。 422 DRS.M01501 Service error. 服务异常。 服务异常，请联系技术人员处理。 202 DRS.M01504 Another operation is being performed on the migration task or the migration task is abnormal. 该迁移任务正在进行其他操作或该迁移任务故障，无法执行该操作，请稍后重试。 请检查当前任务状态。 400 DRS.M05003 Task information not found. 查询不到任务信息。 请检查请求的任务ID。 400 DRS.M05004 The task has been deleted or the resource has been released. 任务已删除或资源已释放。 请检查当前任务状态。 422 DRS.M05006 Invalid RDS DB instance. RDS实例非法。 请检查请求的RDS实例ID。 200 DRS.M05066 Failed to create instance! 创建实例失败。 请联系技术人员处理 400 DRS.M06007 The DB instance cannot be left blank. 数据库实例不能为空。 请检查请求的RDS实例ID。 422 DRS.M06011 Failed to obtain RDS information. 获取RDS信息失败。 请检查请求的RDS实例ID。 422 DRS.M06020 The destination DB instance has been set to read/write by the migration task %s and cannot be used. 目标库实例已被迁移任务%s设置为读写，无法使用该实例。 请更换请求的RDS实例ID。 422 DRS.M06021 The destination DB instance has been set to read/write by the synchronization task %s and cannot be used. 目标库实例已被同步任务%s设置为读写，无法使用该实例。 请更换请求的RDS实例ID。 400 DRS.M07000 The data transformation is already existed! 数据加工规则已存在。 请修改请求的数据加工规则。 200 DRS.KE0001 Failed to connect to the database network. 连接数据库网络失败。 请检查数据库与迁移实例的网络配置。 200 DRS.KE0002 The username or password is incorrect. 用户名或密码错误。 请检查用户名或者密码。 200 DRS.KE0003 The port cannot be accessed. 端口无法访问。 请检查数据库端口。 200 DRS.KE0004 Connection failed.Handling suggestion: Please check the security group/firewall/SSL configuration of the database. 连接失败。 请检查数据库的安全组/防火墙/SSL配置。 200 DRS.KE0005 The database user must allow remote connections.Handling suggestion: Run CREATE USER 'Account'@'%' IDENTIFIED BY 'Password' to create a user that allows remote connections. After the migration, delete this user. 数据库用户必须允许远程连接。 运行CREATE USER'Account'@'%' IDENTIFIED BY 'Password'，创建允许远程连接的用户。迁移完成后，删除该用户。 200 DRS.KE0006 The remote connection permission is not configured in pg_hba.conf for the replication instance and database user.Handling suggestion: Add \"host all xxx(dbuser) 0.0.0.0/0 password\" to the pg_hba.conf configuration file to grant the remote connection permission to the user and restart the database. After the migration is complete, delete this record and restart the database again. pg_hba.conf中没有为复制实例和数据库用户配置远程连接权限。 在pg_hba.conf配置文件中添加\"host all xxx(dbuser) 0.0.0.0/0 password\"，赋予用户远程连接权限，并重新启动数据库。迁移完成后，删除该记录，然后重新启动数据库。 200 DRS.KE0007 The database user does not have the login permission.Handling suggestion: Run alter role xxx (dbuser) login to grant the login permission. 数据库用户没有登录权限。 执行“修改角色xxx (dbuser)登录”命令，赋予登录权限。 200 DRS.KE0008 The specified source database does not exist. Handling suggestion: Create a database or enter an existing database name. 指定的源数据库不存在。 创建数据库或输入现有数据库名称。 200 DRS.KE0009 The SSL CA certificate does not exist.Handling suggestion: Contact technical support. SSL CA证书不存在。 请联系技术支持。 200 DRS.KE0010 SSL is not enabled or the certificate is invalid. Handling suggestion: Enable SSL or upload a valid SSL CA certificate. SSL未启用或证书无效。 启用SSL或上传有效的SSL CA证书。 200 DRS.KE0011 The source database does not have the Microsoft SQL Server replication component installed. 源数据库未安装Microsoft SQL Server复制组件。 安装Microsoft SQL Server复制组件。 200 DRS.KE0012 The user does not have the permission to access the database. 用户没有访问数据库的权限。 给用户添加访问数据库的权限。 200 DRS.KE0013 Insufficient permissions. 权限不足。 给用户添加访问数据库的权限。 200 DRS.KE0014 Internal error. 内部错误。 请联系技术支持。 200 DRS.KE0015 The network connection between the replication instance and database is faulty. 迁移实例与数据库之间的网络连接故障。 请联系技术支持。 200 DRS.KE0016 Failed to connect to the database. In the postgresql.conf file, the listen_addresses parameter value or port number is incorrect.Handling suggestion: In postgres.conf, set listen_addresses to * or change the port number to the correct value. Then, restart the database for the modification to take effect. 连接数据库失败。postgresql.conf文件中，监听地址参数值或端口号不正确。 在postgres.conf中，将监听地址设置为*或将端口号修改为正确的值。然后重启数据库，使修改生效。 200 DRS.KE0017 The IP address cannot be pinged.Handling suggestion: See migration preparations in the DRS Best Practices. 无法ping通IP地址。 请参见DRS最佳实践中的迁移准备。 200 DRS.KE0018 Failed to resolve the domain name. 域名解析失败。 请参见DRS最佳实践中的迁移准备。 200 DRS.KE0019 Failure cause: The subnets of any of the source, destination, or replication (synchronization or disaster recovery) instances in different VPCs overlap. 源库、目标库以及迁移（同步、灾备）实例的其中任意两实例所属VPC的子网CIDR存在重叠 请参见DRS最佳实践中的迁移准备。 200 DRS.KE0020 Incorrect replica set name. 副本集名称错误。 请联系技术支持。 200 DRS.KE0021 The source database cannot connect to the port of the replication instance.Handling suggestion: Modify the firewall and security group configurations of the source and destination databases to enable the source database to connect to the port of the replication instance. See migration preparations in the DRS Best Practices. 源数据库无法连接到复制实例的端口。 修改源数据库和目标数据库的防火墙和安全组配置，使源数据库连接复制实例的端口。请参见DRS最佳实践中的迁移准备。 200 DRS.KE0022 The SSL certificate is incorrect.Handling suggestion: Upload a correct SSL certificate. SSL证书错误。 上传正确的SSL证书。 200 DRS.KE0023 The DRS EIP is not in the whitelist of the source database.Handling suggestion: Add the DRS EIP to the whitelist of the source database. DRS弹性公网IP不在源数据库的白名单中。 将DRS弹性公网IP添加到源数据库的白名单中。 200 DRS.KE0030 The service name is incorrect.Handling suggestion: Check whether the service name is correct before the connection test. 数据库服务名错误。 检查测试连接时输入的数据库服务名是否正确。 200 DRS.KE0031 Query failed.Handling suggestion: Check whether the migration account has sufficient permissions. 查询失败。 检查迁移账号是否有足够的权限。 200 DRS.KE0032 The Oracle certificate is incorrect.Handling suggestion: Upload a correct Oracle certificate. Oracle证书错误。 上传正确的Oracle证书。 200 DRS.KE0033 The username, password, or authentication database of the source database is incorrect.Handling suggestion: Check that the input username, password, and authentication database for the connection test are correct. 源数据库的用户名、密码或鉴权数据库错误。 检查连接测试输入的用户名、密码和认证数据库是否正确。 200 DRS.KE0034 The username, password, or authentication database of the destination database is incorrect.Handling suggestion: Check that the input username, password, and authentication database for the connection test are correct. 目标数据库的用户名、密码或鉴权数据库错误。 检查连接测试输入的用户名、密码和认证数据库是否正确。 200 DRS.KE0035 The database middleware is not a MySQL sharding middleware. 数据库中间件不是MySQL分片中间件。 请联系技术支持。 200 DRS.KE0036 SSL must be enabled when the database password plugin caching_sha2_password is verified.Handling suggestion: Enable SSL or create a user. 验证数据库密码插件cache_sha2_password时，必须启用SSL。 启用SSL或创建用户。 200 DRS.KE0037 The username or password is incorrect.Handling suggestion: Check that the input username and password for the connection test are correct. 用户名或密码错误。 检查连接测试输入的用户名和密码是否正确。 200 DRS.KE0038 The account is locked.Handling suggestion: Contact technical support to unlock the account. 账号已锁定。 请联系技术支持人员解锁账号。 200 DRS.KE0039 The database cannot be connected because the client IP address is not in the whitelist.Handling suggestion: Use an account with the ALTER SYSTEM permission and execute the following SQL statement: alter system add hba entry (hostssl [Username] [Subnet of the RDS instance]);. 客户端IP地址不在白名单中，无法连接数据库。 使用具备ALTER SYSTEM权限账号，执行以下sql: alter system add hba entry (hostssl [用户名] [RDS实例所属的子网网段]) 200 DRS.KE0040 The kafka brokers is not available. Kafka节点不可用。 请联系技术支持。 200 DRS.KE0041 The kafka is not available. Kafka不可用。 请联系技术支持。 200 DRS.KE0042 The kafka topic is not existed. kafka主题不存在。 请联系技术支持。 200 DRS.KE0043 The user does not have the permission to create connections.Grant the required permission to the user and try again. 用户没有创建连接的权限。 为用户授予所需的权限，然后重试。 200 DRS.KE0044 The parameters for test connection contains non-ascii character. Handling suggestion: Please check test connection parameters, use user info without NON-ASCII characters to test connection. 测试连接的参数包含非ascii字符。 请检查测试连接参数，使用不带非ASCII字符的用户信息测试连接。 200 DRS.KE0045 The user account is locked. 用户账号已锁定。 请联系技术支持。 200 DRS.KE0046 The IP address that the user requested to establish a connection is not monitored by the database. 用户请求建立连接的IP地址不受数据库监控。 请联系技术支持。 200 DRS.KE0047 The queue name is not exist.Handling suggestion: Check that the input queue name for the connection test are correct. 队列名称不存在。 检查连接测试的输入队列名称是否正确。 200 DRS.KE0048 Failed to connect to the database. 连接数据库失败。 请联系技术支持。 200 DRS.KE0049 Database user privilege is not enough. 数据库用户权限不足。 请联系技术支持。 200 DRS.KE0050 The PDB database is not open. PDB数据库未打开。 打开PDB数据库。 200 DRS.KE0051 The PDB database does not exist. PDB数据库不存在。 请联系技术支持。 200 DRS.KE0052 Versions earlier than Oracle 12c do not support PDB. Oracle 12c以下版本不支持PDB。 请联系技术支持。 200 DRS.KE0053 Entered Oracle user has insufficient permissions. 输入的Oracle用户权限不足。 请联系技术支持。 200 DRS.KE0054 Agent Connection Failed.Handling suggestion: Please check whether the logical replication agent is enabled or IP address and port number of the logical replication agent is correct. Agent连接失败。 确认逻辑复制代理是否启用，或逻辑复制代理的IP、端口是否正确。 200 DRS.KE0055 Password has expired.Handling suggestion: Please reset the password. 密码过期。 请重置密码。 200 DRS.KE0056 The current instance does not support connections on multiple IP addresses during synchronization. Possible cause: The current instance is connected to a node through multiple IP addresses, which can cause a task to fail. Handling suggestion: Select a stable node, enter the single IP address of the node, and try to connect to the instance again. 当前实例的数据同步不支持用多IP方式进行连接。 请选择某个相对稳定的节点，填写该节点的单IP重新尝试连接。 200 DRS.KE0057 The Kafka user name or password is incorrect. Kafka的用户名或密码不正确。 请检查用户名或者密码。 200 DRS.KE0058 The Kafka encryption certificate or certificate password is incorrect. Kafka加密证书或证书密码不正确。 请检查用户名、密码或者证书。 200 DRS.KE0059 The connected DB engine does not match the DB engine supported by the task. 连接的数据库引擎与任务支持的数据库引擎不匹配。 请联系技术支持。 200 DRS.KE0060 Test connection is succeeded.Handling suggestion: The Oracle database is a RAC cluster. You are advised to use the SCAN IP address as the connection. For details, see here. 测试连接成功。 所提供的Oracle为RAC集群，建议使用SCAN IP作为连接。 200 DRS.KE0061 Possible reasons are:1. The node status is abnormal.2. The primary node information is not specified.3. The whitelist of pg_hba.conf is not configured.4.The network is abnormal. 测试连接失败。可能原因是:1、节点状态异常2、未填写主节点信息3、未配置pg_hba.conf白名单4、网络异常 请联系技术支持。 200 DRS.KE0062 The archived space is full, need to release. 归档空间已满，需要释放。 清理归档空间。 200 DRS.KE0063 The database query result is empty. The database does not have a table or does not have the SELECT permission on the table. 库查询结果为空，库不存在表或者没有表的SELECT等相关权限。 请联系技术支持。 200 DRS.KE0064 The account password has expired.Handling suggestion: Changing the Expired Status of a User to OPEN.Refer to the modification statement: UPDATE SYS.USER$ SET ASTATUS = 0 WHERE NAME = 'user_name'. 账号的密码过期。 修改用户过期状态为OPEN状态.参考修改语句：UPDATE SYS.USER$ SET ASTATUS = 0 WHERE NAME = 'user_name'. 200 DRS.KE0065 Database access denied. Handling suggestion: 1.Check whether the database name is correct before the connection test. 2.Check whether the DB2 database listening port number is correct. 3.Check whether the DB2 server is stopped. 4.Check whether the Firewall is stopped. 数据库访问被拒绝。 1.连接测试前检查数据库名称是否正确。2.检查DB2数据库的监听端口号是否正确。3.检查DB2服务器是否停止。4.检查防火墙是否关闭。 200 DRS.KE0066 The number of DRS task shards must be the same as the actual number of GaussDB shard nodes. DRS任务分片数应与GaussDB实际的分片节点数保持一致。 请联系技术支持。 200 DRS.KE0067 Cannot open user default database. 无法打开用户默认数据库。 请联系技术支持。 200 DRS.KE0068 The GTID format is incorrect. GTID格式不正确。 请联系技术支持。 200 DRS.KE0069 The specified point is unavailable, the specified point must be between the task start point and the current point. 指定位点不满足要求，需要处于任务启动位点和当前位点之间。 请联系技术支持。 200 DRS.KE0070 Connection failed.Handling suggestion: Please check the security group/firewall/SSL configuration/pg_hba.conf whitelist of the database. 连接失败。 请检查数据库的安全组/防火墙/SSL配置/pg_hba.conf白名单。 表2 v5接口错误码 状态码 错误码 错误信息 描述 处理措施 400 DRS.10000001 Failed 失败。 请联系技术人员处理。 400 DRS.10020000 Parameter error:%s 参数错误%s 请检查请求参数。 400 DRS.10020001 Parameter %s is null 参数%s为空。 请检查请求参数。 400 DRS.10020002 The value of parameter %s is invalid. %s 参数取值不合法 请检查请求参数。 400 DRS.10000010 The task does not exist. Check the task ID. 任务不存在，请检查任务ID。 请检查任务ID。 400 DRS.10000011 The database is abnormal. 数据库异常。 请联系技术人员查看日志。 400 DRS.10000012 The start time cannot be the same as the end time. 开始时间不能与结束时间相同。 修改请求参数中的时间。 400 DRS.10010000 The start time cannot be the same as the end time. 开始时间不能与结束时间相同。 修改请求参数中的时间。 400 DRS.10010002 Async job param checking, Please wait param check complete and resubmit. 异步任务正在参数校验中, 请等待参数校验完成后再提交。 等待参数校验完成后再提交。 400 DRS.10010004 Submit job failed. 提交任务失败。 请联系技术人员查看日志。 400 DRS.10010006 Create job failed. 创建任务失败。 请联系技术人员查看日志。 400 DRS.10010007 Test connection failed. 测试连接失败。 请联系技术人员查看日志。 400 DRS.10010009 Set policy config failed,%s 设置任务策略失败，%ss。 检查任务策略。 400 DRS.10010010 Set progressing data failed,%s 设置数据加工数据失败，%s。 检查数据加工规则。 400 DRS.10010011 Set user migration data failed,%s 设置用户迁移数据失败，%s。 检查用户迁移设置。 400 DRS.10010012 Precheck failed,%s 预检查失败，%s。 请联系技术人员查看日志。 400 DRS.10010013 Database param modify success, please restart the database. 数据库实例参数已修改，请重启数据库。 请重启数据库。 400 DRS.10010014 Start job failed,%s 启动任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010016 %s is an EPS system tag and cannot be added manually. %s 是EPS系统标签，无法手动添加。 请检查标签参数。 400 DRS.10010024 Param check failed,%s 参数校验失败，%s。 请检查参数。 400 DRS.10010025 The current API does not support this %s engine type now. 当前API现在不支持此引擎类型。 请修改请求参数。 400 DRS.10010026 Reset job failed,%s. 重置任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010027 Restart job failed,%s. 重试任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010028 Pause job failed,%s. 暂停任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010029 Teminate job failed,%s. 结束任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010030 Delete job failed,%s. 删除任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010031 Test connection timeout. 测试连接超时。 请联系技术人员查看日志。 400 DRS.10010032 Failed to create the comparison task,%s. 创建对比任务失败，%s。 请联系技术人员查看日志。 400 DRS.10010033 Query progress failed,%s. 查询任务进度失败，%s。 请联系技术人员查看日志。 400 DRS.10020072 Invalid projectId. 无效的Project ID。 请检查项目ID。 400 DRS.10020077 Duplicate task name. 任务名称重复。 请检查任务名称。 400 DRS.10030000 Excel content is empty. 上传的Excel内容为空。 请检查上传的excel。 400 DRS.10030001 Excel file size is too large, exceeds the threshold %s. 上传的Excel大小超过阈值，阈值为：%s。 请检查上传的excel大小。 400 DRS.10030002 Excel has more than one sheet. 上传的Excel的sheet超过1个。 请检查上传的excel文件数量。 400 DRS.10030003 The object name is invalid. 对象名称不合法。 请检查对象名称。 400 DRS.10030004 Support the file name extension can be ZIP, JSON, TXT, or Excel 2007 or later (with the file name extension .xlsx/.xls). 支持导入ZIP、JSON、TXT、Excel 2007及以上版本（后缀名为.xlsx/.xls） 请检查导入excel格式。 400 DRS.10030005 Export excel fail. 导出excel文件失败。 请联系技术人员查看日志。 400 DRS.10030006 The file name format is %s. 文件名仅支持 %s。 请检查文件名称。 400 DRS.10030007 The supported file format is .xls or .xlsx. Please check. 支持的文件格式为.xls或.xlsx，请检查。 请检查文件格式。 400 DRS.10030008 Failed to download the file. 下载文件失败。 请联系技术人员查看日志。 400 DRS.10030009 Failed to export data, because %s. 因为%s，导出数据失败。 请联系技术人员查看日志。 400 DRS.10030010 The information of imported database is empty. Please check. 请检查，库信息为空。 请检查导入文件。 400 DRS.10030011 The number of selection database exceeds the limit of 5000. 选择数据库的数量超过了5000的限制。 请检查导入文件。 400 DRS.10030012 Failed to import the Excel file. 导入excel文件失败。 请联系技术人员查看日志。 400 DRS.10020111 The length exceeds %s. 超过限制的长度%s 请检查参数长度。 400 DRS.10060015 Task is waiting for running. 任务正在等待运行 请检查参数长度。 父主题： 附录

请求示例 批量设置同步任务策略，其中增量冲突策略为忽略，同步增量DDL并过滤drop_database操作 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-sync-policy { "jobs": [{ "conflict_policy": "ignore", "ddl_trans": true, "filter_ddl_policy": "drop_database", "index_trans": true, "job_id": "19557d51-1ee6-4507-97a6-8f69164jb201" }] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_full_trans_support_object Boolean 全量任务是否支持对象选择。 is_incre_trans_support_object Boolean 增量任务是否支持对象选择。 is_full_incre_trans_support_object Boolean 全量加增量任务是否支持对象选择。 support_object_import_engine Array of strings 支持对象导入的引擎。 is_support_column_mapping Boolean 是否支持列映射。 is_database_support_search Boolean 库是否支持搜索。 is_schema_support_search Boolean schema是否支持搜索。 is_table_support_search Boolean 表是否支持搜索。 file_size String 对象导入支持的文件大小。 previous_select String 上一次选择迁移对象或者同步对象的方式。 srcImportObject：当前任务上次选择的方式为导入方式。 import_level String 对象导入类型。 table：表级 database：库级

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值，请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn

响应示例 状态码： 200 OK { "is_full_trans_support_object" : false, "is_incre_trans_support_object" : false, "is_full_incre_trans_support_object" : false, "file_size" : "5.0", "support_object_import_engine" : [ "oracle-to-mrsKafka", "oracle-to-kafka" ], "is_support_column_mapping" : false, "is_database_support_search" : true, "is_table_support_search" : true }

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 job_id String 任务id。 object_level_compare_create_result Object 创建对象级对比的结果。 详情请参见表9。 data_level_compare_create_result Object 创建数据级对比的结果。 详情请参见表9。 error_code String 错误码。 error_msg String 错误信息。 表9 object_level_compare_create_result和data_level_compare_create_result字段数据结构说明 参数 参数类型 描述 compare_task_id String 对比任务创建成功后，返回对比任务的id，用于查询该对比任务的结果。 error_code String 错误码。 error_msg String 错误信息。

请求示例 创建对象级对比和数据级行对比任务： https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/create-compare-task { "job_id" : "94800607-3cd8-4f7d-a340-63a10f8jb502", "object_level_compare_type" : "objects", "data_level_compare_info" : { "conflict_policy" : "keep", "compare_type" : "lines", "compare_mode" : null, "start_time" : null, "compare_object_infos" : [ { "db_name" : "may_5", "table_name" : [ "table_name_0", "table_name_1" ] } ] } }

响应示例 状态码： 200 OK { "job_id" : "94800607-3cd8-4f7d-a340-63a10f8jb502", "object_level_compare_create_result" : { "compare_task_id" : "dc1683d9-bdf2-4be9-967f-6ef0953369bc" }, "data_level_compare_create_result" : { "compare_task_id" : "08cad1f8-9de2-42fa-b8ce-6c36daf730f6" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 指定类型为application/json。 缺省值：application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 X-Language 否 String 请求语言类型。 缺省值：en-us 取值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 job_id 是 String 任务ID。 object_level_compare_type 否 String 对象级对比类型，取值为空代表不创建对象级对比。object_level_compare_type和data_level_compare_info都为空时，只查询已创建的对比任务列表。 取值：objects data_level_compare_info 否 Object 数据级对比信息，不创建数据级对比时可以不传。object_level_compare_type和data_level_compare_info都为空时，只查询已创建的对比任务列表。 详情请参见表4。 表4 data_level_compare_info字段数据结构说明 参数 是否必选 参数类型 描述 conflict_policy 是 String 一个任务只允许有一个未完成的数据级对比任务，该字段决定对未完成数据级对比任务的处理方式。cancel：取消后重新创建。keep：保持未完成的不再创建。 取值： cancel keep compare_type 是 String 数据级对比类型，lines：行对比，contents：内容对比。 取值： lines contents 说明： 不能同时进行对象级对比和内容对比。 compare_mode 否 String 数据级对比模式，取值为空时需要在compare_object_infos或者compare_object_infos_with_token传对象信息，quick_comparison-快速对比，需要加入该功能的白名单才能使用。 缺省值：quick_comparison 取值：quick_comparison start_time 否 String 对比任务启动时间，取值为空代表立即启动。 compare_object_infos 否 Array of objects 数据级对比的对象。非“快速对比”模式时，compare_object_infos和compare_object_infos_with_token根据链路二选一传值，不允许都为空。 详情请参见表5。 compare_object_infos_with_token 否 Array of objects 数据级对比的对象（Cassandra灾备专用，带token信息）。非“快速对比”模式时，compare_object_infos和compare_object_infos_with_token根据链路二选一传值，不允许都为空。 详情请参见表6。 表5 compare_object_infos字段数据结构说明 参数 是否必选 参数类型 描述 db_name 是 String 库名。 table_name 否 Array of strings 该库下的表名列表。 表6 compare_object_infos_with_token字段数据结构说明 参数 是否必选 参数类型 描述 db_name 是 String 库名。 table_name_with_token 否 Array of objects 该库下的表信息列表（带token）。 详情请参见表7。 表7 table_name_with_token字段数据结构说明 参数 是否必选 参数类型 描述 table_name 是 String 表名。 min_token 否 String 该表的min token。 max_token 否 String 该表的max token。

响应示例 状态码： 200 OK { "count": 113, "enterprise_project_list": [ { "id": "0", "name": "default", "status": "1" }, { "id": "2d8315f3-f25f-4481-a867-b7ef05a4b9c2", "name": "eps_test_new_改名", "status": "1", "created_at": "2023-01-20T07:18:26Z", "updated_at": "2023-01-20T15:32:29Z" }, { "id": "81b344c4-5644-485b-8ea7-398f3b8013cf", "name": "(!@$%^-_=+[{}]:,./?~#*;|)", "status": "1", "created_at": "2022-09-27T02:41:22Z", "updated_at": "2023-03-01T09:42:02Z" }, { "id": "59add094-0be7-49d0-a3ee-22de62f7eb4c", "name": "DDS-test01_01", "status": "1", "created_at": "2022-02-25T08:04:44Z", "updated_at": "2022-07-13T03:45:24Z" }, { "id": "6e2795dd-6fd1-4413-9038-cf1c1acc0940", "name": "gaussdb_test02", "description": "gaussdb_test02", "status": "1", "created_at": "2022-02-25T07:39:05Z", "updated_at": "2022-02-25T07:39:05Z" } ] } 状态码： 422 Bad Request { "error_code": "DRS.M00277", "error_msg": "该任务名称已存在" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 enterprise_project_list Array of objects 企业项目列表。 详情请参见表5。 表5 enterprise_project_list字段数据结构说明 参数 参数类型 描述 id String 企业项目ID。 name String 企业项目名称。 description String 描述。 status String 企业项目状态。 created_at String 创建时间，例如：2023-01-20T07:18:26Z updated_at String 更新时间，例如：2023-03-01T09:42:02Z 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512