Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Smart Connect/ Verifying Connector Connectivity
Updated on 2026-03-16 GMT+08:00
View PDF

Verifying Connector Connectivity

Function

This API is used to verify the connector connectivity.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/connector/validate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

task

No

SmartConnectTaskRespSourceConfig object

Definition:

Smart Connect task information.

type

Yes

String

Definition:

Smart Connect task type.

Range:

  • OBS_SINK: dump

  • KAFKA_REPLICATOR_SOURCE: Kafka data replication
Table 3 SmartConnectTaskRespSourceConfig

Parameter

Mandatory

Type

Description

current_cluster_name

No

String

Definition:

Current Kafka instance name. (Displayed only when the source type is Kafka.)

Range:

N/A

cluster_name

No

String

Definition:

Target Kafka instance name. (Displayed only when the source type is Kafka.)

Range:

N/A

user_name

No

String

Definition:

Username of a target Kafka instance. (Displayed only when the source type is Kafka.)

Range:

N/A

sasl_mechanism

No

String

Definition:

Target Kafka authentication mode. (Displayed only when the source type is Kafka.)

Range:

  • PLAIN

  • SCRAM-SHA-512

instance_id

Yes

String

Definition:

Target Kafka instance ID. (Displayed only when the source type is Kafka.)

Range:

N/A

bootstrap_servers

No

String

Definition:

Target Kafka instance address. (Displayed only when the source type is Kafka.)

Range:

N/A

security_protocol

No

String

Definition:

Target Kafka authentication mode. (Displayed only when the source type is Kafka.)

Range:

  • PLAINTEXT: SSL is disabled and data is transmitted in plaintext.

  • SASL_SSL: SASL is used for authentication. Data is encrypted with an SSL certificate for high-security transmission.

  • SASL_PLAINTEXT: SASL is used for authentication. Data is transmitted in plaintext for better performance.

direction

No

String

Definition:

Synchronization direction. (Displayed only when the source type is Kafka.)

Range:

  • pull

  • push

  • two-way

sync_consumer_offsets_enabled

No

Boolean

Definition:

Whether to synchronize the consumer offset. (Displayed only when the source type is Kafka.)

Range:

  • true: Yes

  • false: No

replication_factor

No

Integer

Definition:

Number of replicas. (Displayed only when the source type is Kafka.)

Range:

N/A

task_num

No

Integer

Definition:

Number of tasks. (Displayed only when the source type is Kafka.)

Range:

N/A

rename_topic_enabled

No

Boolean

Definition:

Whether to rename a topic. (Displayed only when the source type is Kafka.)

Range:

  • true: Yes

  • false: No

provenance_header_enabled

No

Boolean

Definition:

Whether to add the source header. (Displayed only when the source type is Kafka.)

Range:

  • true: Yes

  • false: No

consumer_strategy

No

String

Definition:

Start offset. (Displayed only when the source type is Kafka.)

Range:

  • latest: obtains the latest data.

  • earliest: obtains the earliest data.

compression_type

No

String

Definition:

Compression algorithm. (Displayed only when the source type is Kafka.)

Range:

  • none

  • gzip

  • snappy

  • lz4

  • zstd

topics_mapping

No

String

Definition:

Topic mapping. (Displayed only when the source type is Kafka.)

Range:

N/A

Response Parameters

Status code: 200

Successful

None

Example Requests

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/validate

{
  "task" : {
    "current_cluster_name" : "A",
    "cluster_name" : "B",
    "instance_id" : "bad80cbe-a6ac-4219-9482-ccbe32a508aa",
    "security_protocol" : "PLAINTEXT",
    "direction" : "pull",
    "sync_consumer_offsets_enabled" : false,
    "replication_factor" : 3,
    "task_num" : 2,
    "rename_topic_enabled" : false,
    "provenance_header_enabled" : false,
    "consumer_strategy" : "earliest",
    "compression_type" : "none",
    "topics_mapping" : ""
  },
  "type" : "KAFKA_REPLICATOR_SOURCE"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent Topic: Smart Connect