ListConnectors - DataHub - Alibaba Cloud Documentation Center

Retrieves a list of synchronization tasks.

Operation description

Queries the list of synchronization tasks.

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

dhs:ListConnectors

list

*Connector

acs:dhs:{#regionId}:{#accountId}:project/{#ProjectName}/topic/{#TopicName}/*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name.	test_project
TopicName	string	Yes	The topic name.	test_topic
Skip	integer	No	The number of records to skip in a paged query.	1
MaxResults	integer	No	The maximum number of records to return in a paged query.	5
NextToken	string	No	The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the previous query indicated by the token.	9892074a2a89600ae4b0d5a34fb99a3f
Keyword	string	No	The filter keyword for the paged query.	dh
Pure	boolean	No	Specifies whether to return only primary key information. Valid values: true : true false : false	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A20A7093-8FE0-058C-BE0C-3C8057D5F1A1
Success	boolean	Indicates whether the request was successful.	True
TotalCount	integer	The total number of query results.	50
MaxResults	integer	The maximum number of records returned in this query.	1
NextToken	string	The pagination token for the next query. If NextToken is empty, no more results are available. If NextToken has a value, it indicates the token from which the next query starts.	9892074a2a89600ae4b0d5a34fb99a3f
List	object
Connector	array<object>	The list of synchronization tasks.
	object	The list of synchronization tasks.
ProjectName	string	Project Name	test_project
TopicName	string	Topic name	test_topic
ConnectorId	string	Sync task ID	fa44384c-0ac5-4d3e-8acd-76e18636ab10
SubscriptionId	string	Subscription ID	1745824636429WZ2EE
Type	string	Synchronization Job Type Valid values: SOURCE_DTS : SOURCE_DTS SINK_ODPS : SINK_ODPS SINK_DATAHUB : SINK_DATAHUB SINK_MYSQL : SINK_MYSQL SINK_HOLOGRES : SINK_HOLOGRES SINK_ADS : SINK_ADS SINK_OSS : SINK_OSS SINK_FC : SINK_FC SINK_OTS : SINK_OTS SINK_ES : SINK_ES	SINK_ODPS
State	string	Synchronization Job Status Valid values: PAUSED : PAUSED CREATED : CREATED RUNNING : RUNNING STOPPED : STOPPED	RUNNING
DoneTime	string	The Done time in the sync task. This parameter takes effect only for SINK_ODPS sync tasks.	2025-12-04 16:45:00
ColumnFields	string	List of fields for the sync task	[\"field1\",\"field2\"]
Config	string	Configuration Information of the Synchronization Job	{\"Table\":\"r3\",\"Endpoint\":\"https://Device-data.cn-beijing.ots-internal.aliyuncs.com\",\"Instance\":\"Device-data\",\"WriteMode\":\"PUT\",\"AuthMode\":\"STS\"}
Creator	string	Creator of the sync task	1696648921408952
CreateTime	string	Creation Time	1724041098000
UpdateTime	string	Last update time	1708171905000

Examples

Success response

JSON format

{
  "RequestId": "A20A7093-8FE0-058C-BE0C-3C8057D5F1A1",
  "Success": true,
  "TotalCount": 50,
  "MaxResults": 1,
  "NextToken": "9892074a2a89600ae4b0d5a34fb99a3f",
  "List": {
    "Connector": [
      {
        "ProjectName": "test_project",
        "TopicName": "test_topic",
        "ConnectorId": "fa44384c-0ac5-4d3e-8acd-76e18636ab10",
        "SubscriptionId": "1745824636429WZ2EE",
        "Type": "SINK_ODPS",
        "State": "RUNNING",
        "DoneTime": "2025-12-04 16:45:00",
        "ColumnFields": "[\\\"field1\\\",\\\"field2\\\"]",
        "Config": "{\\\"Table\\\":\\\"r3\\\",\\\"Endpoint\\\":\\\"https://Device-data.cn-beijing.ots-internal.aliyuncs.com\\\",\\\"Instance\\\":\\\"Device-data\\\",\\\"WriteMode\\\":\\\"PUT\\\",\\\"AuthMode\\\":\\\"STS\\\"}",
        "Creator": "1696648921408952",
        "CreateTime": "1724041098000",
        "UpdateTime": "1708171905000"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Error:%s.	The parameter entered is illegal
400	MissingParameter	Error:%s.	Missing required parameters
500	InternalServerError	Error:%s.	Server error, server unavailable or unexpected error occurred
403	NoPermission	Error:%s.	You are not authorized to perform this operation.
403	OperationDenied	Error:%s.	Operation denied
404	ResourceNotFound	Error:%s.	Resource does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.