Queries a list of synchronization jobs in an AnalyticDB for MySQL cluster.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 most recent region list.
| 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-8vb39udfi356l9psq |
| SourceDBType | string | Yes | The source database type. Enumeration Value:
| 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 obtain details about the source instance or cluster. Enumeration Value:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|