All Products
Search
Document Center

AnalyticDB:ModifySyncJob

Last Updated:Jan 08, 2026

Modifies the synchronization jobs for an AnalyticDB for MySQL cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:ModifySyncJobupdate
DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.
am-bp12bh6z59nh8497f
SourceDBClusterarray<object>No

The source instances or clusters.

objectNo

The source instance or cluster.

TypestringYes

The source database type.

Valid values:

  • rds: ApsaraDB RDS.
  • sls: Simple Log Service.
  • polardb: PolarDB.
sls
OperateTypestringYes

The operation type.

Valid values:

  • Create
  • Modify
Create
ClusterIdsstringYes

The ID of the source instance or cluster. Separate multiple IDs with commas (,).

rm-2zepqn129i9s3l2z3,rm-2zea4dj583129ksp6
RegionIdstringYes

The region ID.

cn-hangzhou
JobIdstringNo

The ID of the synchronization job.

dts-xxxxxx
SyncPlatformstringNo

The synchronization platform.

ADB-CDC

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5AD3D9DF-614F-5B97-9522-A2406A432012

Examples

Sample success responses

JSONformat

{
  "RequestId": "5AD3D9DF-614F-5B97-9522-A2406A432012"
}

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.InvalidSourceDBClusterThe operation is not permitted due to pc-wz9li839to71d2659 not synchronizing with this ADB clusterThe specified source cluster ID is invalid. Check the cluster ID.
500InternalErrorAn error occurred while processing your request.An internal error occurred. Please try again later.
503ServiceUnavailableAn error occurred while processing your request.The system is unavailable. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history