CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
---|---|---|---|---|---|
数据传输服务 | dts | 支持 | 支持 | 资源级 | 部分支持 |
Note:
云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
接口授权粒度分为资源级和操作级两个级别:
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
ActivateSubscribe | 激活数据订阅通道 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
AuthenticateSubscribeSDK | 订阅 SDK 鉴权 | 资源级 | * | 支持 |
CompleteMigrateJob | 完成数据迁移 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
ConfigDataComparisonJob | 配置数据对比任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 不支持 |
ConfigureSubscribeJob | 配置订阅任务 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
ConfigureSyncJob | 配置一个同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
ContinueMigrateJob | 恢复一个暂停中的迁移任务。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
ContinueSyncJob | 恢复处于暂停中的数据同步任务。 | 资源级 | qcs::dts:${Region}:uin/:syncTask/${JobId} | 支持 |
CreateAccessKey | 创建AccessKey | 操作级 | * | 不支持 |
CreateCheckSyncJob | 创建一个同步校验任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
CreateCompareTask | 本接口用于创建数据对比任务,创建成功后会返回数据对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,创建成功后可通过StartCompare启动一致性校验任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
CreateConnectTestJob | 连通性测试 | 资源级 | qcs::dts::uin/${uin}:task/${JobId} | 支持 |
CreateConsumerGroup | 为订阅实例创建消费者组 | 资源级 | qcs::dts:${Region}:uin/:subscribeId/${SubscribeId} | 支持 |
CreateMigrateCheckJob | 创建迁移校验任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
CreateMigrateJob | 创建数据迁移任务 | 操作级 | * | 支持 |
CreateMigrationService | 购买迁移服务。购买成功后会返回随机生成的迁移服务id列表,也可以通过查询迁移服务任务列表接口DescribeMigrationJobs 看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/* | 支持 |
CreateSubscribe | 创建数据订阅 | 操作级 | * | 支持 |
CreateSubscribeCheckJob | 订阅任务配置完成后,发起一个异步的校验任务 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
CreateSyncCompareTask | 本接口用于创建数据对比任务,创建成功后会返回数据对比任务 ID,形如:sync-8yv4w2i1-cmp-37skmii9,创建成功后可通过StartSyncCompare启动一致性校验任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
CreateSyncJob | 本接口(CreateSyncJob)用于创建灾备同步任务。创建同步任务后,可以通过 CreateCheckSyncJob 接口发起校验任务。校验成功后才可以通过 StartSyncJob 接口启动同步任务。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
DeleteCompareTask | 删除一致性校验任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
DeleteConsumerGroup | 删除一个消费组 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DeleteMigrateJob | 删除迁移任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
DeleteSyncCompareTask | 删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
DeleteSyncJob | 删除灾备同步任务 (运行中的同步任务不能删除)。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
DestroyIsolatedSubscribe | 下线已隔离的订阅任务 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DestroyMigrateJob | 下线删除数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口,且只有是已隔离状态下,才能调用此接口销毁任务。对于不计费任务,调用隔离(IsolateMigrateJob)接口删除任务操作。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
DestroySyncJob | 销毁一个同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
IsolateMigrateJob | 隔离退还数据迁移服务。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接删除任务,无法进行恢复操作。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
IsolateSubscribe | 隔离订阅实例 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
IsolateSyncJob | 隔离一个同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
ModifyCompareTask | 修改一致性校验任务,在任务创建后启动之前,可修改一致性校验参数 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
ModifyCompareTaskName | 修改一致性校验任务名称 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
ModifyConsumerGroupDescription | 修改kafka消费组备注 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
ModifyConsumerGroupPassword | 修改消费组密码 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
ModifyMigrateEndpointInfos | 修改tdsql迁移任务的分片信息 | 资源级 | qcs::dts:${Region}:uin/${uin}:task/${JobId} | 支持 |
ModifyMigrateJob | 修改迁移任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
ModifyMigrateJobAddress | 本接口用于修改正在运行中的迁移任务的源IP地址。 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} | 支持 |
ModifyMigrateJobSpec | 调整实例规格,此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口DescribeMigrationJobs 来查询当前任务状态。 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
ModifyMigrateName | 修改迁移名称 | 资源级 | qcs::dts:$region:$account:task/$task | 支持 |
ModifyMigrateRuntimeAttribute | 修改任务运行时属性 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} | 支持 |
ModifyMigrationJob | 配置迁移服务,配置成功后可通过CreateMigrationCheckJob 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
ModifySubscribeAutoRenewFlag | 修改订阅实例自动续费标识 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ModifySubscribeConsumeTime | 修改订阅通道消费时间位点 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ModifySubscribeName | 修改订阅名称 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ModifySubscribeObjects | 修改数据订阅对象 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ModifySubscribeVipVport | 修改订阅服务地址 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ModifySyncCompareTask | 修改一致性校验任务,在任务创建后启动之前,可修改一致性校验参数。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
ModifySyncCompareTaskName | 修改同步一致性校验任务名称 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
ModifySyncEndpointInfos | 修改tdsql分片信息 | 资源级 | qcs::dts:${Region}:uin/${uin}:syncTask/${JobId} | 支持 |
ModifySyncJobName | 修改同步任务名称 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 不支持 |
OfflineIsolatedSubscribe | 下线已隔离的实例 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
PauseMigrateJob | 暂停一个迁移任务。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
PauseSyncJob | 暂停处于同步中的数据同步任务。 | 资源级 | qcs::dts:${Region}:uin/:syncTask/${JobId} | 支持 |
RecoverMigrateJob | 解除隔离数据迁移任务,用户手动发起隔离后的手动解隔离,只有任务状态为已隔离(手动操作)状态下才能触发此操作。调用此接口后可通过查询迁移服务列表接口DescribeMigrationJobs 来查询当前任务状态。 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
RecoverSyncJob | 解除隔离同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
ResetConsumerGroupOffset | 重置kafka offset | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
ResetSubscribe | 重置数据订阅通道 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
ResizeSyncJob | 变配一个同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
ResumeMigrateJob | 本接口(ResumeMigrateJob)用于重试已经失败的迁移任务,保持任务ID不变,目前只支持有覆盖写形态的产品Redis。通过DescribeMigrateJobs接口查询到任务状态为失败(status=10)时,才能重试数据迁移任务。 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} | 支持 |
ResumeSubscribe | 当订阅任务报错时,重启该任务 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
ResumeSyncJob | 恢复同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
SkipCheckItem | 本接口用于校验检查项不通过后,可进行跳过此校验项操作,后端将不再校验该项。任何校验步骤都是不应该跳过的,通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 参考文档。 | 资源级 | qcs::dts:${Region}:uin/:task/${JobId} | 支持 |
SkipSyncCheckItem | 本接口用于校验检查项不通过后,可进行跳过此校验项操作,后端将不再校验该项。任何校验步骤都是不应该跳过的,通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 参考文档。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
StartCompare | 启动一致性校验任务,启动之前需要先通过接口CreateCompareTask 创建一致性校验任务,启动后可通过接口DescribeCompareTasks 查询一致性校验任务列表来获得启动后的状态 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
StartMigrateJob | 启动迁移任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
StartSubscribe | 开启订阅任务 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
StartSyncCompare | 启动一致性校验任务,启动之前需要先通过接口CreateSyncCompareTask 创建一致性校验任务,启动后可通过接口DescribeSyncCompareTasks 查询一致性校验任务列表来获得启动后的状态。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
StartSyncJob | 创建的灾备同步任务在通过 CreateCheckSyncJob 和 DescribeCheckSyncJobResult 确定校验成功后,可以调用该接口启动同步 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
StopCompare | 终止一致性校验任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
StopMigrateJob | 撤销迁移任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
StopSyncCompare | 终止一致性校验任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
StopSyncJob | 终止同步任务 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
DescribeAccessKeys | 查询Access Key | 操作级 | * | 不支持 |
DescribeCheckSyncJobResult | 查询校验同步任务结果 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 支持 |
DescribeCompareReport | 查询一致性校验任务详情 | 资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
DescribeCompareTasks | 查询一致性校验任务列表,调用该接口后可通过接口DescribeCompareTasks 查询一致性校验任务列表来获得启动后的状态。 |
资源级 | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | 支持 |
DescribeConnectTestResult | 查询连通性检查任务结果 | 操作级 | * | 支持 |
DescribeConsumerGroups | 本接口用于获取订阅实例配置的消费者组详情 | 资源级 | * | 支持 |
DescribeDBVariables | 查询数据库参数 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} qcs::dts:${region}:uin/${uin}:syncTask/${JobId} qcs::dts:${region}:uin/${uin}:subscribeId/${JobId} |
支持 |
DescribeDataComparisonResult | 查询数据对比结果 | 资源级 | qcs::dts:$region:uin/:task/$task | 不支持 |
DescribeMigrateCheckJob | 查询校验任务结果 | 资源级 | qcs::dts:$region:uin/:task/$task | 支持 |
DescribeMigrateDBInstances | 查询迁移实例 | 操作级 | * | 支持 |
DescribeMigrateJobs | 查看迁移任务 | 资源级 | qcs::dts:$region:uin/:task/$task | 不支持 |
DescribeMigrateObject | 查看迁移库表 | 操作级 | * | 支持 |
DescribeMigrateProgress | 查询数据迁移进度 | 资源级 | qcs::dts::uin/${uin}:task/${JobId} | 支持 |
DescribeMigrationCheckJob | 本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度. 若通过校验, 则可调用StartMigrateJob 开始迁移.若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过ModifyMigrationJob 修改迁移配置或是调整源/目标实例的相关参数. |
资源级 | qcs::dts:${Region}:uin/:task/${JobId} | 支持 |
DescribeMigrationDetail | 查询某个数据迁移任务详情 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} | 支持 |
DescribeOffsetByTime | 查询kafka offset | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DescribeSubscribeCheckJob | 查询校验任务的结果 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DescribeSubscribeConf | 查询订阅配置 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
DescribeSubscribeDetail | 查询订阅任务配置 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DescribeSubscribeReturnable | 查询订阅实例是否可以退换 | 资源级 | qcs::dts:$region:$account:subscribeId/$subscribeId | 支持 |
DescribeSubscribes | 获取数据订阅实例列表 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DescribeSyncCompareReport | 查询一致性校验任务详情 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
DescribeSyncCompareTasks | 查询一致性校验任务列表。通过该接口可查看改任务下所有一致性校验任务。 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | 支持 |
DescribeSyncDbInstances | 查询数据库实例列表 | 操作级 | * | 支持 |
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
DescribeMigrationJobs | 查询数据迁移任务列表 | 资源级 | qcs::dts:${region}:uin/${uin}:task/${JobId} | 支持 |
DescribeSubscribeJobs | 查询订阅任务列表 | 资源级 | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 支持 |
DescribeSyncJobs | 查询同步任务列表 | 资源级 | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | 不支持 |
本页内容是否解决了您的问题?