文档首页/ 数据复制服务 DRS/ CLI参考/ CLI命令参考（V5）

更新时间：2026-09-07 GMT+08:00

CLI命令参考（V5）

资源管理

API名称	命令	描述	操作
查询可用链路信息	hcloud DRS ListLinks/v5	根据参数不同，可查询实时迁移、实时同步、实时灾备等可用链路信息。	去调试
查询所有特性白名单的信息	hcloud DRS ListFeatures/v5	根据参数不同，可查询所有特性开关的状态。	去调试
查询可用链路信息	hcloud DRS ListSupportLinks/v5	根据参数不同，可查询实时迁移、实时同步、实时灾备等可用链路信息。	去调试

实例管理

API名称	命令	描述	操作
查询任务列表	hcloud DRS ListJobs/v5	查询租户任务列表，可以根据企业项目，引擎类型，网络类型，任务状态，任务名称，任务ID进行查询。	去调试
创建任务	hcloud DRS CreateJob/v5	创建单个任务，根据请求参数不同，可以创建单个实时迁移、实时同步、实时灾备等任务。	去调试
批量删除任务	hcloud DRS BatchDeleteJobsById/v5	批量删除租户指定ID任务。	去调试
更新指定ID任务详情	hcloud DRS UpdateJob/v5	更新租户指定ID任务详情。	去调试
删除指定ID任务	hcloud DRS DeleteJob/v5	删除租户指定ID任务。	去调试
克隆任务	hcloud DRS CopyJob/v5	DRS支持通过克隆功能，快速复制现有同步任务的配置。	去调试
按需转包周期	hcloud DRS ChangeToPeriod/v5	DRS同步和灾备任务按需计费转包周期计费。	去调试
查询订阅任务列表	hcloud DRS ShowSubscriptionLists/v5	查询订阅任务列表，可以根据企业项目，引擎类型，网络类型，任务状态，任务名称，任务ID进行查询。	去调试
删除订阅任务	hcloud DRS DeleteSubscription/v5	删除订阅任务。	去调试
创建订阅任务	hcloud DRS CreateSubscription/v5	创建订阅任务。	去调试
修改订阅任务的信息	hcloud DRS UpdateSubscriptionInfo/v5	修改订阅任务的信息	去调试

批量异步实例管理

API名称	命令	描述	操作
批量异步创建任务	hcloud DRS BatchCreateJobsAsync/v5	批量异步创建任务，根据请求参数不同，可以批量异步创建实时迁移、实时同步、实时灾备等任务。	去调试
查询批量异步创建的任务列表	hcloud DRS ListAsyncJobs/v5	查询租户批量异步创建的任务列表。	去调试
提交批量创建异步任务	hcloud DRS CommitAsyncJob/v5	提交批量创建异步任务，当批量异步任务创建或更新参数后，系统会自动开始进行参数校验，待所有任务成功完成参数校验后并且无报错时，可调用此接口开始创建DRS任务实例。	去调试
查询指定ID批量异步任务详情	hcloud DRS ListAsyncJobDetail/v5	查询租户指定ID批量异步任务详情，默认为任务的“create_time”降序排序获取结果，支持分页查询。	去调试
更新指定ID批量异步任务详情	hcloud DRS UpdateBatchAsyncJobs/v5	更新租户指定ID批量异步任务详情。	去调试
下载批量导入任务模板	hcloud DRS DownloadBatchCreateTemplate/v5	下载批量导入任务模板	去调试
批量导入任务	hcloud DRS ImportBatchCreateJobs/v5	批量导入任务	去调试
导出创建模板	hcloud DRS ExportCreationTemplate/v5	根据已有任务导出创建模板。（异步操作，需要调查询导出进度接口查询结果。）	去调试
查询导出创建模板进度	hcloud DRS ShowExportProgress/v5	查询导出批量创建模板进度。	去调试
查询创建模板列表	hcloud DRS ListTemplates/v5	查询批量创建模板列表。	去调试
下载创建模板	hcloud DRS DownloadCreateTemplate/v5	下载根据已有任务导出的创建模板。	去调试

实例数据库对象配置

API名称	命令	描述	操作
查询数据库对象信息	hcloud DRS ListDbObjects/v5	查询数据库对象信息。	去调试
对象选择（文件导入 - 模板上传）	hcloud DRS UploadDbObjectTemplate/v5	对象选择（文件导入 - 模板上传）。	去调试
对象选择（文件导入 - 模板下载）	hcloud DRS DownloadDbObjectTemplate/v5	对象选择（文件导入 - 模板下载）。	去调试
对象选择（文件导入 - 进度查询）	hcloud DRS ShowDbObjectTemplateProgress/v5	对象选择（文件导入 - 进度查询）。	去调试
对象选择（文件导入 - 获取导入结果）	hcloud DRS ShowDbObjectTemplateResult/v5	对象选择（文件导入 - 获取导入结果）。	去调试
获取提交查询数据库对象信息的结果	hcloud DRS ShowDbObjectCollectionStatus/v5	获取提交查询数据库对象信息的结果。	去调试
获取对象保存进度	hcloud DRS ShowUpdateObjectSavingStatus/v5	获取对象保存进度。	去调试
提交查询数据库对象信息	hcloud DRS CollectDbObjectsAsync/v5	提交查询数据库对象信息。例如：	去调试
查询同步映射列表	hcloud DRS ShowObjectMapping/v5	查询实时同步映射关系包括对象选择时的库映射、schema映射、表映射和数据加工时的列映射。	去调试
查询是否支持对象选择和列映射	hcloud DRS ShowSupportObjectType/v5	查询任务支持的对象选择类型、列映射、支持搜索的对象类型等信息。	去调试
提交查询数据库对象信息	hcloud DRS CollectDbObjectsInfo/v5	提交查询数据库对象信息。例如：	去调试
查询数据库对象信息	hcloud DRS ShowDbObjectsList/v5	查询数据库对象信息。	去调试
查询对象的列信息（列映射、列过滤）	hcloud DRS ShowColumnInfos/v5	查询对象的列信息（列映射、列过滤）	去调试
删除对象的列信息（列映射、列过滤）	hcloud DRS DeleteColumnInfos/v5	删除对象的列信息（列映射、列过滤）	去调试
修改对象的列信息（列映射、列过滤）	hcloud DRS ModifyColumnInfos/v5	修改对象的列信息（列映射、列过滤）	去调试

实例详情

API名称	命令	描述	操作
查询任务详情	hcloud DRS ShowJobDetail/v5	查询任务详情。	去调试
获取任务价格信息	hcloud DRS ShowMetering/v5	获取询价接口的参数。	去调试
查询异常数据列表	hcloud DRS ShowDirtyData/v5	查询异常数据列表。	去调试
导出任务操作统计信息	hcloud DRS ExportOperationInfo/v5	导出指定任务操作统计信息。	去调试
查询监控数据	hcloud DRS ShowMonitorData/v5	获取任务监控数据。	去调试
查询增量组件详情	hcloud DRS ShowIncrementComponentsDetail/v5	查询任务同步的增量组件的详细信息，实时同步任务，任务模式为增量或者全量+增量才支持。具体介绍可以参考：查询同步进度	去调试
展示时间轴	hcloud DRS ShowTimeline/v5	指定不同的任务ID可以展示当前任务创建时间、启动时间、重试、重置等操作的时间轴信息。	去调试
查询订阅任务详情	hcloud DRS ShowSubscriptionDetail/v5	查询订阅任务详情，可以根据企业项目和任务ID查询各订阅任务详情。	去调试
查询用户对比详情	hcloud DRS ShowCompareUsersDetail/v5	查询用户对比详情	去调试
SMN主题查询	hcloud DRS ShowSmnTopicInfo/v5	SMN主题查询。	去调试
查询子任务数量	hcloud DRS ShowChildNum/v5	根据ddm/gaussv5数据库的分片个数计算对应子任务数量	去调试

实例操作

API名称	命令	描述	操作
操作指定ID任务	hcloud DRS ExecuteJobAction/v5	操作租户指定ID任务。	去调试
结束任务	hcloud DRS StopJobAction/v5	结束租户指定ID任务。	去调试
批量操作指定ID任务	hcloud DRS BatchExecuteJobActions/v5	批量操作租户指定ID任务。	去调试
获取指定任务操作信息	hcloud DRS ShowActions/v5	获取指定任务允许、不允许、当前操作信息。	去调试
任务名称校验	hcloud DRS ValidateJobName/v5	创建任务时对任务名称进行校验。	去调试
批量结束任务	hcloud DRS BatchStopJobsAction/v5	批量结束租户指定ID任务。	去调试
更新增量任务启动位点	hcloud DRS UpdateStartPosition/v5	更新增量任务的启动位点。	去调试
采集数据库位点信息	hcloud DRS CollectPositionAsync/v5	采集数据库位点信息。	去调试
获取查询数据库位点的结果	hcloud DRS ShowPositionResult/v5	获取查询数据库位点的结果	去调试
上传驱动文件（不再推广）	hcloud DRS UploadJdbcDriver/v5	上传驱动文件。	去调试
上传驱动文件	hcloud DRS UploadUserJdbcDriver/v5	上传驱动文件。	去调试
删除驱动文件（不再推广）	hcloud DRS DeleteJdbcDriver/v5	删除驱动文件。	去调试
查询驱动文件列表（不再推广）	hcloud DRS ListJdbcDrivers/v5	查询驱动文件列表。	去调试
同步驱动文件（不再推广）	hcloud DRS SyncJdbcDriver/v5	同步驱动文件。	去调试
同步驱动文件	hcloud DRS SyncUserJdbcDriver/v5	同步驱动文件。	去调试
删除驱动文件	hcloud DRS DeleteUserJdbcDriver/v5	删除驱动文件。	去调试
查询驱动文件列表	hcloud DRS ListUserJdbcDrivers/v5	查询驱动文件列表。	去调试

对比管理

API名称	命令	描述	操作
查询对比策略	hcloud DRS ShowComparePolicy/v5	查询对比策略。	去调试
修改对比策略	hcloud DRS UpdateComparePolicy/v5	修改周期性对比的对比策略，目前仅MySQL->MySQL、MySQL->GaussDB(for MySQL)、MySQL->GaussDB(DWS)、GaussDB(for MySQL)->MySQL同步任务，MySQL->MySQL、MySQL->GaussDB(for MySQL)迁移任务，MySQL->MySQL、MySQL->GaussDB(for MySQL)、GaussDB(for MySQL)->GaussDB(for MySQL)、DDM->DDM、DDS-DDS灾备任务支持对比策略设置。	去调试
查询健康对比列表	hcloud DRS ShowHealthCompareJobList/v5	查询健康对比列表。	去调试
查询数据级流式对比列表	hcloud DRS ShowProgressData/v5	查询不同迁移对象类型的迁移进度。	去调试
查询健康对比任务详情	hcloud DRS ShowHealthCompareJobDetail/v5	查询健康对比任务详情。	去调试
获取健康对比对象级对比概览	hcloud DRS ShowHealthObjectCompareJobOverview/v5	获取健康对比对象级对比概览。	去调试
查询对比任务进度	hcloud DRS ShowCompareProgress/v5	查询运行中对比任务的对比进度。	去调试
暂停对比任务	hcloud DRS PauseCompareJobs/v5	暂停对比任务	去调试
继续对比任务	hcloud DRS RestartCompareJobs/v5	继续对比任务	去调试

企业项目管理

API名称	命令	描述	操作
查询企业项目列表	hcloud DRS ShowEnterpriseProject/v5	查询企业项目列表。	去调试

数据加工

API名称	命令	描述	操作
更新指定任务数据加工规则	hcloud DRS UpdateDataProgress/v5	更新指定任务数据加工规则	去调试
查询数据加工规则	hcloud DRS ShowDataProgress/v5	查询数据加工规则:包含数据库表的映射信息、列信息、数据过滤信息、附加列信息、DDL以及DML信息	去调试
获取指定任务数据加工规则更新结果	hcloud DRS ShowDataProcessingRulesResult/v5	获取指定任务数据加工规则更新结果	去调试
数据过滤规则校验	hcloud DRS CheckDataFilter/v5	数据过滤规则校验	去调试
获取数据过滤校验结果	hcloud DRS ShowDataFilteringResult/v5	获取数据过滤校验结果	去调试
采集指定数据库表的列信息	hcloud DRS CollectColumns/v5	采集指定数据库表的列信息	去调试
获取指定数据库表列信息	hcloud DRS ShowColumnInfoResult/v5	获取指定数据库表列信息	去调试
查询数据加工对象的附加列信息	hcloud DRS ListExtraColumns/v5	查询数据加工对象的附加列信息	去调试

标签管理

API名称	命令	描述	操作
批量添加或删除资源标签	hcloud DRS BatchTagAction/v5	批量添加删除资源标签。	去调试
查询项目标签	hcloud DRS ListProjectTags/v5	查询指定project ID下不同任务类型的所有标签集合。	去调试
查询资源标签	hcloud DRS ShowInstanceTags/v5	查询指定实例的标签信息。	去调试
批量添加资源标签	hcloud DRS BatchCreateTags/v5	批量添加资源标签。	去调试
批量删除资源标签	hcloud DRS BatchDeleteTags/v5	为指定实例批量删除标签。	去调试
查询资源实例列表	hcloud DRS ListInstanceByTags/v5	查询资源实例列表。	去调试
查询资源实例数量	hcloud DRS CountInstanceByTags/v5	查询资源实例数量。	去调试
查询资源标签	hcloud DRS ListInstanceTags/v5	查询指定实例的标签信息。	去调试
查询项目标签	hcloud DRS ListTags/v5	查询租户在指定Project中实例类型的所有资源标签集合。	去调试

参数管理

API名称	命令	描述	操作
更新任务的参数信息	hcloud DRS UpdateJobConfigurations/v5	更新任务的参数信息。	去调试
查询任务参数配置列表	hcloud DRS ListJobParameters/v5	查询任务的参数配置列表信息	去调试
查询任务的参数配置修改历史	hcloud DRS ListJobHistoryParameters/v5	查询任务的参数配置修改历史	去调试

权限管理

API名称	命令	描述	操作
查询委托的权限列表	hcloud DRS ListsAgencyPermissions/v5	根据源库类型，目标库类型，是否自建，获取委托所需要的权限	去调试
查询委托权限详情	hcloud DRS ShowAgencyInfo/v5	查询委托权限详情	去调试
更新委托权限策略	hcloud DRS UpdateAgencyPolicy/v5	更新委托权限策略	去调试

录制回放

API名称	命令	描述	操作
查询录制回放结果	hcloud DRS ShowReplayResults/v5	获取录制回放结果数据，包括：回放基于时间维度统计信息，异常SQL及统计结果、慢SQL及统计结果	去调试
查询录制回放任务进度	hcloud DRS ShowReplayProgress/v5	查询录制回放任务进度	去调试
查询流量回放任务的报告文件导出状态	hcloud DRS ShowReplayReportExportStatus/v5	查询流量回放任务的报告文件导出状态	去调试
导出流量回放任务SQL报告文件	hcloud DRS ExportReplayReport/v5	导出流量回放任务SQL报告文件	去调试

连接管理

API名称	命令	描述	操作
查询连接列表	hcloud DRS ListConnections/v5	查询连接列表，可根据连接类型进行查询。	去调试
创建连接	hcloud DRS CreateConnection/v5	创建单个连接，该连接可以为线下自建库或云上RDS等，目前支持的数据库引擎包括MySQL、PostgreSQL、Oracle和MongoDB。	去调试
修改连接	hcloud DRS ModifyConnection/v5	修改创建的连接信息。	去调试
删除连接	hcloud DRS DeleteConnection/v5	删除租户指定的连接。	去调试

配置管理

API名称	命令	描述	操作
查询增量DDL列表	hcloud DRS ListJobDdls/v5	查询增量DDL列表，可根据status查询	去调试
清除DDL告警	hcloud DRS CleanAlarms/v5	清除DDL告警	去调试

备份迁移

API名称	命令	描述	操作
查询备份迁移任务列表	hcloud DRS ListReplicationJobs/v5	获取当前备份迁移任务列表，不包含已删除的任务。	去调试
创建备份迁移任务	hcloud DRS CreateReplicationJob/v5	该接口主要用于三种常见场景下备份迁移任务的配置。	去调试
删除备份迁移任务	hcloud DRS DeleteReplicationJob/v5	对于已经完成的备份迁移任务，可以选择删除迁移任务。	去调试
查询备份迁移任务详细信息	hcloud DRS ShowReplicationJob/v5	获取指定备份迁移任务详细信息。	去调试
修改备份迁移任务信息	hcloud DRS UpdateReplicationJob/v5	修改指定备份迁移任务信息，任务名与任务描述。	去调试

上一篇：CLI命令参考（V3）