DescribeStreamingJob_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为3000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:DescribeStreamingJob
Delete
DBInstance
acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

请求参数

字段名称字段详情
RegionIdstring

地域 ID。展开详情

示例值:cn-beijing参考取值来源:
    DescribeRegions
JobIdinteger<int32>

任务 ID。

示例值:1
DBInstanceIdstring

实例 ID。

示例值:gp-bp10g78o9807yv9h3参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
JobIdstring

任务 ID。

示例值:1
JobNamestring

任务名称。

示例值:test-job
JobDescriptionstring

任务描述。

示例值:test_job
DataSourceIdstring

数据源 ID。

示例值:2
SrcColumnsarray<string>

源端字段列表。

DestColumnsarray<string>

目标数据表映射字段列表。

MatchColumnsarray<string>

匹配列,通常为目标表的所有主键列,此配置内所有列的值相同即视为两行数据为重复数据。

UpdateColumnsarray<string>

更新列,通常为目标表的所有非主键列,当通过 MatchColumns 确定数据重复时,通过更新 UpdateColumns 列的值,产生使新数据覆盖旧数据的效果。

Accountstring

目标数据库账号。

示例值:test-account
Passwordstring

目标数据库密码。

示例值:pwd123
DestDatabasestring

目标数据库名称。

示例值:dest-db
DestSchemastring

目标命名空间。

示例值:dest-schema
DestTablestring

目标表名称。

示例值:dest-table
WriteModestring

写入模式。

示例值:INSERT/UPDATE/MERGE
Modestring

配置模式展开详情

示例值:basic/professional
JobConfigstring

任务配置文件。

示例值:DATABASE: adbpgss_test USER: adbpgss_test PASSWORD: adbpgssTest HOST: gp-xxx-master.gpdb.rds-aliyun-pre.rds.aliyuncs.com PORT: 5432 KAFKA: INPUT: SOURCE: BROKERS: broker1:9092,broker2:9092,broker3:9092 TOPIC: testtopic FALLBACK_OFFSET: earliest KEY: COLUMNS: - NAME: customer_id TYPE: int FORMAT: delimited DELIMITED_OPTION: DELIMITER: '|' VALUE: COLUMNS: - TYPE: integer NAME: l_orderkey - TYPE: integer NAME: l_partkey - TYPE: integer NAME: l_suppkey - TYPE: integer NAME: l_linenumber - TYPE: decimal NAME: l_quantity - TYPE: decimal NAME: l_extendedprice - TYPE: decimal NAME: l_discount - TYPE: decimal NAME: l_tax - TYPE: char NAME: l_returnflag - TYPE: char NAME: l_linestatus - TYPE: date NAME: l_shipdate - TYPE: date NAME: l_commitdate - TYPE: date NAME: l_receiptdate - TYPE: text NAME: l_shipinstruct - TYPE: text NAME: l_shipmode - TYPE: text NAME: l_comment FORMAT: delimited DELIMITED_OPTION: DELIMITER: '|' ERROR_LIMIT: 10 OUTPUT: SCHEMA: adbpgss_test TABLE: write_with_insert_plaintext MODE: MERGE MATCH_COLUMNS: - l_orderkey - l_partkey - l_suppkey UPDATE_COLUMNS: - l_linenumber - l_quantity - l_extendedprice - l_discount - l_tax - l_returnflag - l_linestatus - l_shipdate - l_commitdate - l_receiptdate - l_shipinstruct - l_shipmode - l_comment MAPPING: - EXPRESSION: l_orderkey NAME: l_orderkey - EXPRESSION: l_partkey NAME: l_partkey - EXPRESSION: l_suppkey NAME: l_suppkey - EXPRESSION: l_linenumber NAME: l_linenumber - EXPRESSION: l_quantity NAME: l_quantity - EXPRESSION: l_extendedprice NAME: l_extendedprice - EXPRESSION: l_discount NAME: l_discount - EXPRESSION: l_tax NAME: l_tax - EXPRESSION: l_returnflag NAME: l_returnflag - EXPRESSION: l_linestatus NAME: l_linestatus - EXPRESSION: l_shipdate NAME: l_shipdate - EXPRESSION: l_commitdate NAME: l_commitdate - EXPRESSION: l_receiptdate NAME: l_receiptdate - EXPRESSION: l_shipinstruct NAME: l_shipinstruct - EXPRESSION: l_shipmode NAME: l_shipmode - EXPRESSION: l_comment NAME: l_comment COMMIT: MAX_ROW: 1000 MINIMAL_INTERVAL: 1000 CONSISTENCY: ATLEAST POLL: BATCHSIZE: 1000 TIMEOUT: 1000 PROPERTIES: group.id: testgroup
Statusstring

服务状态,取值:展开详情

示例值:Running
ErrorMessagestring

服务状态信息,例如异常情况,则显示异常原因。正常 Running 状态下空值。

示例值:""
CreateTimestring<iso8601_normal>

创建时间。

示例值:2019-09-08T16:00:00Z
ModifyTimestring<iso8601_normal>

最后修改时间。

示例值:2019-09-08T17:00:00Z
GroupNamestring

kafka 分组名称

示例值:test_group
Consistencystring

投递保证。

示例值:ATLEAST / EXACTLY
ErrorLimitCountinteger<int32>

kafka 中的数据与 adbpg 目标表不匹配造时会造成写入失败,此值为允许错误行的行数,超出后会造成任务失败。

示例值:5
FallbackOffsetstring

FallbackOffset 回退点位,回退偏移量展开详情

示例值:EARLIEST / LATEST
DataSourceNamestring

数据源名称。

示例值:test_kafka

返回示例

变更历史

暂无变更历史

相关示例