更新时间:2025-08-12 GMT+08:00
分享

校验Connector连通性

功能介绍

校验Connector连通性。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

task

SmartConnectTaskRespSourceConfig object

参数解释

Smart Connect任务信息。

type

String

参数解释

Smart Connect任务类型。

取值范围

  • OBS_SINK:转储。

  • KAFKA_REPLICATOR_SOURCE:Kafka数据复制。

表3 SmartConnectTaskRespSourceConfig

参数

是否必选

参数类型

描述

current_cluster_name

String

参数解释

当前Kafka实例别名。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

cluster_name

String

参数解释

对端Kafka实例别名。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

user_name

String

参数解释

对端Kafka用户名。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

sasl_mechanism

String

参数解释

对端Kafka认证机制。(仅源端类型为Kafka时会显示)

取值范围

  • PLAIN

  • SCRAM-SHA-512

instance_id

String

参数解释

对端Kafka实例ID。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

bootstrap_servers

String

参数解释

对端Kafka实例地址。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

security_protocol

String

参数解释

对端Kafka认证方式。(仅源端类型为Kafka时会显示)

取值范围

  • PLAINTEXT:不开启SSL,明文传输。

  • SASL_SSL:采用SASL方式进行认证,数据通过SSL证书进行加密传输,安全性更高。

  • SASL_PLAINTEXT:采用SASL方式进行认证,数据通过明文传输,性能更好。

direction

String

参数解释

同步方向。(仅源端类型为Kafka时会显示)

取值范围

  • pull:拉取。

  • push:推送。

  • two-way:双向。

sync_consumer_offsets_enabled

Boolean

参数解释

是否同步消费进度。(仅源端类型为Kafka时会显示)

取值范围

  • true:同步消费进度

  • false:不同步消费进度

replication_factor

Integer

参数解释

副本数。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

task_num

Integer

参数解释

任务数。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

rename_topic_enabled

Boolean

参数解释

是否重命名Topic。(仅源端类型为Kafka时会显示)

取值范围

  • true:重命名Topic。

  • false:不进行重命名Topic。

provenance_header_enabled

Boolean

参数解释

是否添加来源header。(仅源端类型为Kafka时会显示)

取值范围

  • true:添加来源header。

  • false:不添加来源header。

consumer_strategy

String

参数解释

启动偏移量。(仅源端类型为Kafka时会显示)

取值范围

  • latest:获取最新的数据。

  • earliest:获取最早的数据。

compression_type

String

参数解释

压缩算法。(仅源端类型为Kafka时会显示)

取值范围

  • none

  • gzip

  • snappy

  • lz4

  • zstd

topics_mapping

String

参数解释

Topic映射。(仅源端类型为Kafka时会显示)

取值范围

不涉及。

响应参数

状态码:200

Connector连通成功。

请求示例

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

响应示例

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Connector连通成功。

错误码

请参见错误码

相关文档