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.
Two authorization granularity levels of API are supported: resource level, and operation level.
API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
---|---|---|---|---|
ActivateSubscribe | active subscribe channel | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
AuthenticateSubscribeSDK | Binlog Subscribe Authentication | Resource 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 the migration job. | Resource level | qcs::dts:$region:uin/:task/$task | Supported |
ConfigDataComparisonJob | Configure the data comparison task. | Resource level | qcs::dts:$region:uin/:task/$task | not 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/${uin}:syncTask/${syncTask} | Supported |
ContinueMigrateJob | continue the job in paused | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
ContinueSyncJob | continue the job in paused | Resource level | qcs::dts:${Region}:uin/:syncTask/${JobId} | Supported |
CreateAccessKey | Create the access key. | Operation level | * | not supported |
CreateCheckSyncJob | create a check sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
CreateCompareTask | Create Compare Task | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
CreateConnectTestJob | Create connect test job | Resource level | qcs::dts::uin/${uin}:task/${JobId} | Supported |
CreateConsumerGroup | create consumer group for a subscribe instance | Resource level | qcs::dts:${Region}:uin/:subscribeId/${SubscribeId} | Supported |
CreateMigrateCheckJob | Create the migration verification job. | Resource level | qcs::dts:$region:uin/:task/$task | Supported |
CreateMigrateJob | Create the data migration job. | Operation level | * | Supported |
CreateMigrationService | Create Migration Service | Resource level | qcs::${ApiModule}:${Region}:uin/:task/* | Supported |
CreateOptimizeTableTaskForDts | start an optimizing table task for the dst db | Resource level | qcs::dts::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 |
CreateSubscribe | create subscribe instance | 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 |
CreateSyncCompareTask | CreateSyncCompareTask | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${JobId} | Supported |
CreateSyncJob | create a sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
DeleteCompareTask | Delete Compare Task | Resource level | qcs::${ApiModule}:${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 |
DeleteSyncJob | delete sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
DestroyIsolatedSubscribe | offline an isolated subscribe job | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
DestroyMigrateJob | Destroy Migrate Job | Resource level | qcs::${ApiModule}:${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::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
IsolateSubscribe | isolate subscribe instance | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
IsolateSyncJob | isolate sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
ModifyCompareTask | ModifyCompareTask | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
ModifyCompareTaskName | Modify Compare Task Name | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
ModifyConsumerGroupDescription | modify kafka consumer offset | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
ModifyConsumerGroupPassword | modify consumer group\'s password | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 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::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
ModifyMigrateName | modify migrate name | Resource level | qcs::dts:$region:$account:task/$task | Supported |
ModifyMigrateRuntimeAttribute | Modify migrate runtime attribute | Resource level | qcs::dts:${region}:uin/${uin}:task/${JobId} | Supported |
ModifyMigrationJob | Modify Migration Job | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
ModifySubscribeAutoRenewFlag | modify subscribe instance auto renew flag | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
ModifySubscribeConsumeTime | modify subscribe consume time | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
ModifySubscribeName | modify subscriibe instance name | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
ModifySubscribeObjects | modify subscribe object | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
ModifySubscribeVipVport | modify subscribe vip vport | Resource level | qcs::dts:$region:$account: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 |
ModifySyncEndpointInfos | modify endpoints information for replicate task | Resource level | qcs::dts:${Region}:uin/${uin}:syncTask/${JobId} | Supported |
ModifySyncJobName | modify sync job name | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
OfflineIsolatedSubscribe | offline isolated subscribe instance | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
PauseMigrateJob | pause a migrate job | Resource level | qcs::${ApiModule}:${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::${ApiModule}:${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 subscribe channel | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | 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/${uin}:syncTask/${JobId} | Supported |
StartCompare | Start Compare | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
StartMigrateJob | Start the migration job. | Resource level | qcs::dts:$region:uin/:task/$task | 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 |
StartSyncJob | start sync job | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
StopCompare | StopCompare | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
StopMigrateJob | Stop the migration job. | Resource level | qcs::dts:$region:uin/:task/$task | 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 |
API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
---|---|---|---|---|
DescribeAccessKeys | Inquire the access key. | Operation level | * | not supported |
DescribeCheckSyncJobResult | describe check sync job result | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | Supported |
DescribeCompareReport | Describe Compare Report | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
DescribeCompareTasks | DescribeCompareTasks | Resource level | qcs::${ApiModule}:${Region}:uin/:task/${JobId} | Supported |
DescribeConnectTestResult | Describe connect test result | Operation level | * | Supported |
DescribeConsumerGroups | to get information of consumer groups of the specific subscribe instance | Resource level | * | 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 |
DescribeDataComparisonResult | Inquire the data comparison result. | Resource level | qcs::dts:$region:uin/:task/$task | not 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 the each task\\\'s details of migration. | Resource level | qcs::dts:$region:uin/:task/$task | not supported |
DescribeMigrateObject | Operation level | * | Supported | |
DescribeMigrateProgress | Describe migrate progress | Resource level | qcs::dts::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 |
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 |
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 |
DescribeSubscribeDetail | describe subscribe job\\\\\\\'s information | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | Supported |
DescribeSubscribeReturnable | describe subscribe returnable | Resource level | qcs::dts:$region:$account:subscribeId/$subscribeId | Supported |
DescribeSubscribes | describe subscribe jobs | Resource level | qcs::dts:${region}:uin/${uin}:subscribeId/${SubscribeId} | 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 |
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 |
DescribeSyncJobs | describe sync jobs | Resource level | qcs::dts:${region}:uin/${uin}:syncTask/${syncTask} | not supported |
Was this page helpful?