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
|
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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task |
No |
Definition: Smart Connect task information. |
|
|
type |
No |
String |
Definition: Smart Connect task type. Range:
|
|
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:
|
|
instance_id |
No |
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:
|
|
direction |
No |
String |
Definition: Synchronization direction. (Displayed only when the source type is Kafka.) Range:
|
|
sync_consumer_offsets_enabled |
No |
Boolean |
Definition: Whether to synchronize the consumer offset. (Displayed only when the source type is Kafka.) Range:
|
|
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:
|
|
provenance_header_enabled |
No |
Boolean |
Definition: Whether to add the source header. (Displayed only when the source type is Kafka.) Range:
|
|
consumer_strategy |
No |
String |
Definition: Start offset. (Displayed only when the source type is Kafka.) Range:
|
|
compression_type |
No |
String |
Definition: Compression algorithm. (Displayed only when the source type is Kafka.) Range:
|
|
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
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/validate
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.