All Products
Search

This Product

    AnalyticDB:ModifySyncJob

    Document Center

    AnalyticDB:ModifySyncJob

    Last Updated:Aug 28, 2026

    Modifies the synchronization jobs for an AnalyticDB for MySQL cluster.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    adb:ModifySyncJob

    update

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    DBClusterId

    string

    Yes

    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
    SourceDBCluster

    array<object>

    No

    The source instances or clusters.

    object

    No

    The source instance or cluster.

    Type

    string

    Yes

    The source database type.

    Valid values:

    • rds: ApsaraDB RDS.

    • sls: Simple Log Service.

    • polardb: PolarDB.

    Valid values:

    • rds :

      rds

    • sls :

      sls

    • polardb :

      polardb

    sls
    OperateType

    string

    Yes

    The operation type.

    Valid values:

    • Create

    • Modify

    Valid values:

    • Create :

      Create

    • Modify :

      Modify

    Create
    ClusterIds

    string

    Yes

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

    rm-2zepqn129i9s3l2z3,rm-2zea4dj583129ksp6
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    JobId

    string

    No

    The ID of the synchronization job.

    dts-xxxxxx
    SyncPlatform

    string

    No

    The synchronization platform.

    ADB-CDC

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 OperationDenied.InvalidSourceDBCluster The operation is not permitted due to pc-wz9li839to71d2659 not synchronizing with this ADB cluster The specified source cluster ID is invalid. Check the cluster ID.
    500 InternalError An error occurred while processing your request. An internal error occurred. Please try again later.
    503 ServiceUnavailable An error occurred while processing your request. The system is unavailable. Please try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.