All Products
Search
Document Center

AnalyticDB:ListStreamingJobs

Last Updated:Jan 24, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries real-time data synchronization jobs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:ListStreamingJobsdelete
*DBInstance
acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-beijing
DBInstanceIdstringYes

Instance ID.

gp-bp10g78o9807yv9h3
PageSizeintegerNo

Number of records per page, with the following options:

  • 30 - 50 - 100 Default value: 30.
kafka
PageNumberintegerNo

Page number, greater than 0 and not exceeding the maximum value of Integer. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
PageNumberinteger

Current page number.

1
PageRecordCountinteger

Number of records per page.

2
TotalRecordCountinteger

Total number of records.

2
JobItemsarray<object>

The queried jobs.

itemsobject
JobIdstring

The job ID.

1
JobNamestring

The name of the job.

test-job
DataSourceIdstring

The data source ID.

58
JobDescriptionstring

The description of the job.

test job
SrcColumnsarray

The source fields.

srcColumnsstring

The name of the source field.

src_column_1
DestColumnsarray

The mapped fields in the destination table.

destColumnsstring

The name of the mapped field in the destination table.

dest_column_1
MatchColumnsarray

The update condition columns that are used to join the source data and the destination table. Typically, the columns are all the primary key columns of the destination table. If the values of all columns specified by this parameter in different rows are the same, the rows are considered duplicates.

matchColumnsstring

The name of the update condition column.

column_1
UpdateColumnsarray

The columns to be updated if a row of data meets the update condition. Typically, the columns are all non-primary key columns of the destination table. When the columns specified by the MatchColumns parameter are used as conditions to join the source data and the destination table, data in columns of the UpdateColumns type is updated if data is matched.

updateColumnsstring

The name of the column to be updated.

column_1
Accountstring

The name of the database account.

test-account
Passwordstring

The password of the database account.

pwd123
DestDatabasestring

The name of the destination database.

dest-db
DestSchemastring

The name of the destination namespace.

dest-schema
DestTablestring

The name of the destination table.

dest-table
WriteModestring

The write mode.

INSERT/UPDATE/MERGE
Modestring

The configuration mode. Valid values:

  1. basic: In basic mode, you must configure the configuration parameters.
  2. professional: In professional mode, you can submit a YAML configuration file.
Basic / Professional
ErrorMessagestring

The error message returned.

This parameter is returned only when the return value of Status is false.

""
Statusstring

The status of the job. Valid values:

  • Init
  • Running
  • Exception
  • Paused
Running
CreateTimestring

The time when the job was created.

2019-09-08T16:00:00Z
ModifyTimestring

The time when the job was last modified.

2019-09-08T17:00:00Z
FallbackOffsetstring

The fallback offset for data consumption.

  • This parameter indicates the starting offset from which data consumption resumes when a consumer does not request a consumption offset or requests a consumption offset that is beyond the range of the offset information recorded in the current Kafka cluster. Valid values: EARLIEST and LATEST.
EARLIEST / LATEST
Consistencystring

The delivery guarantee setting.

ATLEAST / EXACTLY
DataSourceNamestring

The name of the data source.

test-kafka

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.