DescribeSyncJobList - 查询集群同步作业列表

更新时间:
复制为 MD 格式

查询集群同步作业列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeSyncJobListget
DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看支持的地域和可用区信息,包括地域 ID。
cn-hangzhou
DBClusterIdstring

数仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。
am-8vb39udfi356l9psq
SourceDBTypestring

源端数据库类型。

枚举值:
  • rdsrds
  • slssls
  • polardbpolardb
sls
PageSizeinteger

每页的记录数。

30
PageNumberinteger

页码,取值为:大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
SourceDBClusterIdstring

源端实例 ID。

pc-t4n766v2llx852n81
SourceDBClusterDescriptionstring

源端实例描述。

test
GetSourceDetailboolean

是否获取源端详细信息。

枚举值:
  • truetrue
  • falsefalse
true

返回参数

名称类型描述示例值
object
TotalCountinteger

总记录条数。

100
PageSizeinteger

每页大小。

30
RequestIdstring

请求 ID。

482B8BAE-6EC0-5C0E-B2AF-FD42A3FC5B67
PageNumberinteger

分页页码。

1
DBClusterIdinteger

集群 ID。

am-j6c22lubl8d9l3989
SyncJobsarray<object>

同步作业列表。

SyncJobobject

同步作业列表。

SourceStorageSizeinteger

源端实例存储空间大小。

100
SourceDBClusterIdstring

源端实例 ID。

pc-t4n766v2llx852n81
JobIdstring

同步任务 ID。

dts-xxxxx
SourceDBTypestring

源端实例数据库类型。

polardb
SourceDBClusterDescriptionstring

源端实例描述信息。

test
RegionIdstring

地域 ID。

cn-hangzhou
SourceTableNumberinteger

源端实例表数量。

100
SyncPlatformstring

同步平台。

ADB-CDC

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request.系统内部错误,请稍后重试
503ServiceUnavailableAn error occurred while processing your request.系统暂时不可用,请稍后重试

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史