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
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; public class ValidateConnectorConnectivitySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); ValidateConnectorConnectivityRequest request = new ValidateConnectorConnectivityRequest(); request.withInstanceId("{instance_id}"); SmartConnectValidateEntity body = new SmartConnectValidateEntity(); request.withBody(body); try { ValidateConnectorConnectivityResponse response = client.validateConnectorConnectivity(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = ValidateConnectorConnectivityRequest() request.instance_id = "{instance_id}" request.body = SmartConnectValidateEntity( ) response = client.validate_connector_connectivity(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kafka.NewKafkaClient( kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ValidateConnectorConnectivityRequest{} request.InstanceId = "{instance_id}" request.Body = &model.SmartConnectValidateEntity{ } response, err := client.ValidateConnectorConnectivity(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot