Track Real-Time Sync Jobs via ListStreamingJobs API - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Queries real-time data synchronization jobs.

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:ListStreamingJobs

delete

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
DBInstanceId	string	Yes	The instance ID.	gp-bp10g78o9807yv9h3
PageSize	integer	No	The number of records per page. Valid values: 30 - 50 - 100 Default value: 30.	kafka
PageNumber	integer	No	The page number. Valid values: greater than 0 and up to the maximum value of Integer. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
PageNumber	integer	The current page number.	1
PageRecordCount	integer	The number of records per page.	2
TotalRecordCount	integer	The total number of records.	2
JobItems	array<object>	The queried jobs.
	object
JobId	string	The job ID.	1
JobName	string	The name of the job.	test-job
DataSourceId	string	The data source ID.	58
JobDescription	string	The description of the job.	test job
SrcColumns	array	The source fields.
	string	The name of the source field.	src_column_1
DestColumns	array	The mapped fields in the destination table.
	string	The name of the mapped field in the destination table.	dest_column_1
MatchColumns	array	The columns used to match source data against the destination table. Typically, these are the primary key columns of the destination table. Rows with identical values in all specified columns are considered duplicates.
	string	The name of the update condition column.	column_1
UpdateColumns	array	The columns to update when a source row matches the destination table on the MatchColumns values. Typically, these are all non-primary key columns of the destination table.
	string	The name of the column to be updated.	column_1
Account	string	The name of the database account.	test-account
Password	string	The password of the database account.	pwd123
DestDatabase	string	The name of the destination database.	dest-db
DestSchema	string	The name of the destination namespace.	dest-schema
DestTable	string	The name of the destination table.	dest-table
WriteMode	string	The write mode.	INSERT/UPDATE/MERGE
Mode	string	The configuration mode. Valid values: basic: In basic mode, you must configure the configuration parameters. professional: In professional mode, you can submit a YAML configuration file.	basic / professional
ErrorMessage	string	The error message returned. This parameter is returned only when the return value of Status is false.	""
Status	string	The status of the job. Valid values: Init Running Exception Paused	Running
CreateTime	string	The time when the job was created.	2019-09-08T16:00:00Z
ModifyTime	string	The time when the job was last modified.	2019-09-08T17:00:00Z
FallbackOffset	string	The fallback offset for data consumption. The starting offset from which data consumption resumes when the requested offset is missing or out of range. Valid values: EARLIEST and LATEST.	EARLIEST / LATEST
Consistency	string	The delivery guarantee setting.	ATLEAST / EXACTLY
DataSourceName	string	The name of the data source.	test-kafka

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.