Retrieve & Filter Sync Jobs via DescribeSyncJobList API - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Queries the synchronization jobs of an AnalyticDB for MySQL Data Warehouse Edition 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:DescribeSyncJobList

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the available regions.	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 cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters in a region.	am-8vb39udfi356l9psq
SourceDBType	string	No	The source database type. Valid values: rds : rds sls : sls polardb : polardb	sls
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
SourceDBClusterId	string	No	The ID of the source cluster. You can call the DescribeDBClusters operation to query backup set IDs. Note If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.	pc-t4n766v2llx852n81
SourceDBClusterDescription	string	No	The description of the source cluster.	test
GetSourceDetail	boolean	No	Specifies whether to return details about the source instance or cluster. Valid values: true : true false : false	true

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	30
RequestId	string	The request ID.	482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67
PageNumber	integer	The page number.	1
DBClusterId	integer	The cluster ID.	am-j6c22lubl8d9l3989
SyncJobs	array<object>	The queried synchronization jobs.
	object	The queried synchronization job.
SourceStorageSize	integer	The storage size of the source instance or cluster.	100
SourceDBClusterId	string	The ID of the source cluster. You can call the DescribeDBClusters operation to query backup set IDs. Note If you want to restore the data of an ApsaraDB for ClickHouse cluster, this parameter is required.	pc-t4n766v2llx852n81
JobId	string	The ID of the Spark job.	dts-xxxxx
SourceDBType	string	The database type of the source instance or cluster.	polardb
SourceDBClusterDescription	string	The description of the source instance or cluster.	test
RegionId	string	The region ID.	cn-hangzhou
SourceTableNumber	integer	The number of tables in the source instance or cluster.	100
SyncPlatform	string	The synchronization platform.	ADB-CDC

Examples

Success response

JSON format

{
  "TotalCount": 100,
  "PageSize": 30,
  "RequestId": "482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67",
  "PageNumber": 1,
  "DBClusterId": 0,
  "SyncJobs": [
    {
      "SourceStorageSize": 100,
      "SourceDBClusterId": "pc-t4n766v2llx852n81",
      "JobId": "dts-xxxxx",
      "SourceDBType": "polardb",
      "SourceDBClusterDescription": "test",
      "RegionId": "cn-hangzhou",
      "SourceTableNumber": 100,
      "SyncPlatform": "ADB-CDC"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.