Data Transfer Service
Last updated: 2025-12-04 09:09:53
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| Data Transfer Service | dts | Supported | Supported | Resource level | Partially supported |
Note：
The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.
- Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
- Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
- Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.
API authorization granularity
Two authorization granularity levels of API are supported: resource level, and operation level.
- Resource level: It supports the authorization of a specific resource.
- Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.
Write operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| AssumeRole | Assume role | Operation level | * | Supported |
| CancelOptimizeTableTaskForDts | cancel the running optimizing table tasks | Resource level | qcs::dts:${region}:uin/:task/${JobId} | Supported |
| CancelOptimizeTableTaskForSync | cancel the running optimizing table tasks | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| CompleteMigrateJob | Complete Migrate Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ConfigureMaintainWindow | Configure maintain window | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} |
Supported |
| ConfigureSubscribeJob | configure a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ConfigureSyncJob | configure a sync job | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| ContinueMigrateJob | continue the job in paused | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ContinueSyncJob | continue the job in paused | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| CreateCheckSyncJob | create a check sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| CreateCompareTask | Create Compare Task | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| CreateConnectTestJob | Create connect test job | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| CreateConsumerGroup | create consumer group for a subscribe instance | Resource level | qcs::dts:${Region}:uin/:subscribeId/${SubscribeId} | Supported |
| CreateMigrateCheckJob | Create migrate check job | Resource level | qcs::dts::uin/${uin}:task/${JobId} | Supported |
| CreateMigrateJob | Create the data migration job. | Operation level | * | Supported |
| CreateMigrationService | Create Migration Service | Operation level | * | Supported |
| CreateModifyCheckSyncJob | Create a check task to modify the synchronization configuration | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| CreateOptimizeTableTaskForDts | start an optimizing table task for the dst db | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| CreateOptimizeTableTaskForSync | start an optimizing table task for the dst db | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| CreateRecheckTask | create a recheck task for an comapre task with increment mode | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| CreateSubscribe | create a subscribe job | Operation level | * | Supported |
| CreateSubscribeCheckJob | start an asynchronous check task for a subscribe job since it was configured | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| CreateSubscribeSignature | create a signature for payment | Operation level | * | not supported |
| CreateSubscribeTestConnect | Create subscribe test connect | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | not supported |
| CreateSyncCompareTask | CreateSyncCompareTask | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| CreateSyncRecheckTask | create a recheck task for an comapre task with increment mode | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| CreateSyncSignature | create a signature for payment | Operation level | * | not supported |
| DeleteCompareTask | Delete Compare Task | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DeleteConsumerGroup | delete a consumer group for a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DeleteMigrateJob | Delete the migrate job | Resource level | qcs::dts:$region:uin/:task/$task | Supported |
| DeleteSyncCompareTask | DeleteSyncCompareTask | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DestroyIsolatedSubscribe | offline an isolated subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DestroyMigrateJob | Destroy Migrate Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DestroySyncJob | destroy sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| IsolateMigrateJob | Isolate Migrate Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| IsolateSubscribe | isolate a subscribe job | Resource level | qcs::dts:${Region}:uin/:subscribeId/${SubscribeId} | Supported |
| IsolateSyncJob | isolate sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| ModifyCompareTask | ModifyCompareTask | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ModifyCompareTaskName | Modify Compare Task Name | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ModifyConsumerGroupDescription | modify kafka consumer offset | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifyConsumerGroupPassword | ModifyConsumerGroupPassword | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifyIncrementPosition | modify start position when a task is in increment phase | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| ModifyMigrateAutoRetryConf | Modify migrate auto retry conf | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | not supported |
| ModifyMigrateDbVariable | Modify migrate DB variable | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | not supported |
| ModifyMigrateEndpointInfos | modify endpoints information for migrate task | Resource level | qcs::dts:${Region}:uin/${uin}:task/${JobId} | Supported |
| ModifyMigrateJob | Modify the migration job. | Resource level | qcs::dts:$region:uin/:task/$task | Supported |
| ModifyMigrateJobAddress | Modify Migrate Job Address | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| ModifyMigrateJobSpec | Modify Migrate Job Spec | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ModifyMigrateName | modify migrate job name | Resource level | qcs::dts:$region:$account:task/$task | Supported |
| ModifyMigrateOptions | Modify migrate options | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | not supported |
| ModifyMigrateRateLimit | Modify migrate rate limit | Resource level | qcs::dts::uin/${uin}:task/${JobId} | Supported |
| ModifyMigrateRuntimeAttribute | Modify migrate runtime attribute | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| ModifyMigrationJob | Modify Migration Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| ModifyReplicateJobName | modify sync job name | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| ModifySubsEndpointInfos | modify subscribe job endpoint info | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifySubsProConsumerNet | modify consumer vpc and subnet | Resource level | qcs::dts::uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifySubscribeAutoRenewFlag | modify subscribe instance auto renew flag | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
| ModifySubscribeName | modify a subscribe job\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\'s name | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifySubscribeObjects | modify and restart subscribe objects and some configurations for a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ModifySyncCompareTask | ModifySyncCompareTask | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| ModifySyncCompareTaskName | ModifySyncCompareTaskName | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| ModifySyncDbVariable | Modify sync DB variable | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| ModifySyncEndpointInfos | modify endpoints information for replicate task | Resource level | qcs::dts:${Region}:uin/${uin}:syncTask/${JobId} | Supported |
| ModifySyncIncrementPosition | modify start position when a task is in increment phase | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| ModifySyncJobAutoRetryConf | Modify sync job auto retry conf | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| ModifySyncJobConfig | Modify Sync Job Config | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| ModifySyncJobName | modify sync job name | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| ModifySyncRateLimit | modify sync rate limit | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| PauseMigrateJob | pause a migrate job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| PauseSyncJob | pause a sync job | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| RecoverMigrateJob | Recover Migrate Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| RecoverSyncJob | Recover Sync Job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| ResetConsumerGroupOffset | reset kafka offset on some partitions | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ResetSubscribe | reset a subscribe job and you can configure and start it again | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ResetSyncJob | ResetSyncJob | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| ResizeSyncJob | resize sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| ResumeMigrateJob | Resume Migrate Job | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| ResumeSubscribe | resume a subscribe job when it throws an error | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| ResumeSyncJob | resume a sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| SkipCheckItem | Skip check item | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| SkipSyncCheckItem | Skip sync check item | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| StartCompare | Start Compare | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| StartMigrateJob | Start Migrate Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| StartModifySyncJob | Start Modify Sync Job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| StartSubscribe | start a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| StartSyncCompare | StartSyncCompare | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| StopCompare | StopCompare | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| StopMigrateJob | Stop Migrate Job | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| StopSyncCompare | StopSyncCompare | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| StopSyncJob | stop sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| TestDbConnection | create sync connect test | Resource level | qcs::dts::uin/${uin}:syncTask/${JobId} | not supported |
Other Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| CheckOrderInSrcAndDst | Configuration of condition coverage priority for sync task check | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
| CheckTableFilterConditionInfo | Check table Filter condition Info | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| CheckTableFilterConditionInfoForMigrate | check whether the where condition is legal for specific objects | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DescribeAccountMigrationCheckResult | DescribeAccountMigrationCheckResult | Resource level | qcs::dts:${region}:uin/${uin}:task/$task | Supported |
| DescribeAdvancedObjectsDifference | Describe advanced objects difference | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeAllSurvey | Describe all survey | Operation level | * | not supported |
| DescribeCheckReplicateJobRes | Describe result for sync job check | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
| DescribeCheckSyncJobResult | describe check sync job result | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
| DescribeColumns | describe a column\\\'s or a table\\\'s information in a migrate job | Resource level | qcs::dts:${region}:uin/:task/${JobId} | Supported |
| DescribeCompareDiffItems | Query inconsistency details | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeCompareReport | Describe Compare Report | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DescribeCompareTasks | DescribeCompareTasks | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DescribeConflictAlertInfo | Describe conflict alert info | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| DescribeConnectTestResult | Describe connect test result | Operation level | * | Supported |
| DescribeConsumerGroups | to get information of consumer groups of the specific subscribe instance | Resource level | qcs::dts:${Region}:uin/:subscribeId/${SubscribeId} | Supported |
| DescribeDBVariables | describe variables of databases | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} qcs::dts:${region}:uin/${uin}:syncTask/${JobId} qcs::dts:${region}:uin/${uin}:subscribeId/${JobId} |
Supported |
| DescribeDataDifference | Describe data difference | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeDataInitialize | Describe data initialize progress | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
| DescribeDtsReplicateObject | Describe DTS Sync Objects | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DescribeJobLogStatement | describe details of a task log | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| DescribeJobStatusHistory | Describe job status history | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} qcs::dts:${region}:uin/${uin}:syncTask/${JobId} qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} |
Supported |
| DescribeMigrateCheckJob | Inquire the verification task results | Resource level | qcs::dts:$region:uin/:task/$task | Supported |
| DescribeMigrateDBInstances | Describe Migrate Database Instances | Operation level | * | Supported |
| DescribeMigrateJobs | Describe migrate jobs | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeMigrateObject | Describe migrate object | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeMigrateOptions | Describe migrate task options | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeMigrateProgress | Describe migrate progress | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeMigrationCheckJob | Describe Migration Check Job | Resource level | qcs::dts:${Region}:uin/:task/${JobId} | Supported |
| DescribeMigrationDetail | Describe Migration Detail | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeModifyCheckSyncJobResult | DescribeModifyCheckSyncJobResult | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DescribeModifyMigrateDbVariable | Describe modify migrate DB variable | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | not supported |
| DescribeModifySyncDbVariable | Describe modify sync DB variable | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| DescribeModifySyncJob | describe options and objects of a sync task before and after modifying | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| DescribeOffsetByTime | describe kafka offset for a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeOptimizeTableTaskForDts | describe progress of latest optimize table task | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
| DescribeOptimizeTableTaskForSync | describe progress of latest optimize table task | Resource level | qcs::dts:${region}:uin/:syncTask/${JobId} | Supported |
| DescribeProgress | Describe progress | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} qcs::dts:${region}:uin/${uin}:syncTask/${JobId} |
not supported |
| DescribeRowsDifference | Describe rows difference | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeStructureInitialize | Describe structure initialize progress | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
| DescribeSubscribeCheckJob | describe the information and result of last check task of this subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeConf | describe subscribe configure | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
| DescribeSubscribeDBDatabases | Describe subscribe DB databases | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeDBInstances | Describe subscribe DB Instances | Resource level | qcs::dts::uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeDBTables | Describe subscribe DB tables | Resource level | qcs::dts::uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeDetail | describe information of a subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeReturnable | describe whether a subscribe job could be isolated | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSubscribeTestConnectResult | Describe subscribe test connect result | Operation level | * | not supported |
| DescribeSubscribes | describe subscribe jobs | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
| DescribeSyncCompareDiffItems | Query inconsistency details | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | not supported |
| DescribeSyncCompareReport | DescribeSyncCompareReport | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DescribeSyncCompareTasks | DescribeSyncCompareTasks | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DescribeSyncDbInstances | describe syn db instance | Operation level | * | Supported |
| DescribeSyncProgress | Describe sync progress | Resource level | qcs::dts:${Region}:uin/${uin}:syncTask/${JobId} | not supported |
| DescribeSyncReturnable | Verify refund eligibility for the current instance | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | not supported |
| DescribeTableStructureInfos | Describe table structure infos | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
| DescribeTestDbConnection | describe sync connect result | Operation level | * | not supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeMigrationJobs | Describe Migration Jobs | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
| DescribeSubscribeJobs | describe subscribe jobs | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback