ListStreamingJobs - 查询所有实时数据同步任务 - 云原生数据仓库AnalyticDB

查询所有实时数据同步任务。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:ListStreamingJobs	delete	*DBInstance `acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。说明您可以调用 DescribeRegions 接口查看可用的地域 ID。	cn-beijing
DBInstanceId	string	是	实例 ID。	gp-bp10g78o9807yv9h3
PageSize	integer	否	每页记录数，取值说明： 30 50 100 默认值：30。	kafka
PageNumber	integer	否	页码，大于 0 且不超过 Integer 的最大值，默认值：1。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
PageNumber	integer	当前页码。	1
PageRecordCount	integer	当前页记录数。	2
TotalRecordCount	integer	总记录数。	2
JobItems	array<object>	返回的任务列表。
items	object
JobId	string	任务 ID。	1
JobName	string	任务名称。	test-job
DataSourceId	string	数据源 ID。	58
JobDescription	string	任务描述。	test job
SrcColumns	array	源端数据字段列表。
srcColumns	string	源端数据字段键值。	src_column_1
DestColumns	array	目标数据表映射字段列表。
destColumns	string	目标表里面的映射字段键值。	dest_column_1
MatchColumns	array	匹配列，通常为目标表的所有主键列，此配置内所有列的值相同即视为两行数据为重复数据。
matchColumns	string	匹配字段键值。	column_1
UpdateColumns	array	更新列，通常为目标表的所有非主键列，当通过 MatchColumns 确定数据重复时，通过更新 UpdateColumns 列的值，产生使新数据覆盖旧数据的效果。
updateColumns	string	更新字段键值。	column_1
Account	string	账号名称。	test-account
Password	string	密码。	pwd123
DestDatabase	string	目标数据库名称。	dest-db
DestSchema	string	目标命名空间。	dest-schema
DestTable	string	目标表名称。	dest-table
WriteMode	string	写入模式。	INSERT/UPDATE/MERGE
Mode	string	配置模式 basic 模式需要指定一些配置字段 professional 支持提交 yaml 文件	basic / professional
ErrorMessage	string	错误信息。只会在 Status 参数返回值为 false 时返回该参数。	""
Status	string	服务状态，取值： Init：初始化中 Running：运行中 Exception：异常 Paused：暂停	Running
CreateTime	string	创建时间。	2019-09-08T16:00:00Z
ModifyTime	string	最后修改时间。	2019-09-08T17:00:00Z
FallbackOffset	string	FallbackOffset 回退点位，回退偏移量 FallbackOffset 参数定义了当 consumer 没有请求需要消费的位点或者请求的消费的位点超出当前 kafka 集群的记录的位点信息的时候的行为。可以选择从 earliest（最新）或者 latest（最晚）位点开始消费。	EARLIEST / LATEST
Consistency	string	投递保证。	ATLEAST / EXACTLY
DataSourceName	string	数据源名称。	test-kafka

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "PageNumber": 1,
  "PageRecordCount": 2,
  "TotalRecordCount": 2,
  "JobItems": [
    {
      "JobId": "1",
      "JobName": "test-job",
      "DataSourceId": "58",
      "JobDescription": "test job",
      "SrcColumns": [
        "src_column_1"
      ],
      "DestColumns": [
        "dest_column_1"
      ],
      "MatchColumns": [
        "column_1"
      ],
      "UpdateColumns": [
        "column_1"
      ],
      "Account": "test-account",
      "Password": "pwd123",
      "DestDatabase": "dest-db",
      "DestSchema": "dest-schema",
      "DestTable": "dest-table",
      "WriteMode": "INSERT/UPDATE/MERGE",
      "Mode": "basic / professional",
      "ErrorMessage": "\"\"",
      "Status": "Running",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z",
      "FallbackOffset": "EARLIEST /  LATEST",
      "Consistency": "ATLEAST / EXACTLY",
      "DataSourceName": "test-kafka"
    }
  ]
}

错误码

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