All Products
Search

This Product

    AnalyticDB:CreateStreamingJob

    Document Center

    AnalyticDB:CreateStreamingJob

    Last Updated:Aug 27, 2026

    Create External Data Source Configuration

    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

    gpdb:CreateStreamingJob

    create

    *DBInstance

    acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    Region ID.

    Note

    You can call the DescribeRegions API to view available region IDs.

    cn-beijing
    DBInstanceId

    string

    Yes

    Instance ID.

    gp-bp10g78o9807yv9h3
    DataSourceId

    string

    Yes

    Data source ID.

    1
    JobDescription

    string

    No

    Job description.

    test-job
    JobName

    string

    Yes

    Job name.

    test-job
    Mode

    string

    No

    Configuration mode

    1. Basic mode requires specifying some configuration fields

    2. Professional mode supports submitting a YAML file

    basic / professional
    SrcColumns

    array

    No

    Source data field list.

    string

    No

    Source data field key.

    src_column_1
    DestColumns

    array

    No

    Target data table mapping field list.

    string

    No

    Mapping field key in the target table.

    dest_column_1
    Account

    string

    No

    Target database account.

    test-account
    Password

    string

    No

    Target database password.

    pwd123
    DestDatabase

    string

    No

    Target database name.

    dest-db
    DestSchema

    string

    No

    Target namespace.

    dest-schema
    DestTable

    string

    No

    Target table name.

    dest-table
    WriteMode

    string

    No

    Write mode.

    Valid values:

    • MERGE :

      MERGE

    • INSERT :

      INSERT

    • UPDATE :

      UPDATE

    INSERT/UPDATE/MERGE
    TryRun

    boolean

    No

    Whether to test the real-time task, values:

    • true

    • false

    Default value: false.

    true
    JobConfig

    string

    No

    Job configuration file, required for professional mode.

    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

    GroupName

    string

    No

    Kafka group name

    group_name.
    FallbackOffset

    string

    No

    FallbackOffset, fallback offset

    • The FallbackOffset parameter defines the behavior when the consumer does not request a specific offset or the requested offset exceeds the current Kafka cluster's recorded offset information. You can choose to start consuming from the earliest (newest) or latest (oldest) offset.

    Valid values:

    • EARLIEST :

      EARLIEST

    • LATEST :

      LATEST

    EARLIEST / LATEST
    MatchColumns

    array

    No

    Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows of data are considered duplicates.

    string

    No

    Match field key.

    column_1
    UpdateColumns

    array

    No

    Update columns, usually all non-primary key columns of the target table. When data is determined to be duplicate through MatchColumns, updating the UpdateColumns column values will result in new data overwriting old data.

    string

    No

    Update field key.

    column_1
    ErrorLimitCount

    integer

    No

    When data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed; exceeding this will cause the task to fail.

    5
    Consistency

    string

    No

    Delivery guarantee.

    ATLEAST / EXACTLY

    Response elements

    Element

    Type

    Description

    Example

    object

    JobId

    integer

    Job ID.

    1
    RequestId

    string

    Request ID.

    B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

    Examples

    Success response

    JSON format

    {
  "JobId": 1,
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.