# 查询Smart Connect任务列表 - ListConnectorTasks #### 功能介绍 查询Smart Connect任务列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:listConnectorSinkTask | List | kafka \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | dms:instance:listConnectorTasks | #### URI GET /v2/{project_id}/instances/{instance_id}/connector/tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 偏移量，表示从此偏移量开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 分页查询单页数量。 **约束限制**： 不涉及。 **取值范围**： 1\~50 **默认取值**： 10 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | tasks | Array of [SmartConnectTaskEntity] objects | **参数解释**： Smart Connect任务详情。 | | total_number | Integer | **参数解释**： Smart Connect任务数。 **取值范围**： 不涉及。 | | max_tasks | Integer | **参数解释**： Smart Connect最大任务数。 **取值范围**： 不涉及。 | | quota_tasks | Integer | **参数解释**： Smart Connect任务配额。 **取值范围**： 不涉及。 | 表4SmartConnectTaskEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_name | String | **参数解释**： Smart Connect任务名称。 **取值范围**： 不涉及。 | | topics | String | **参数解释**： Smart Connect任务配置的Topic。 **取值范围**： 不涉及。 | | topics_regex | String | **参数解释**： Smart Connect任务配置的Topic正则表达式。 **取值范围**： 不涉及。 | | source_type | String | **参数解释**： Smart Connect任务的源端类型。 **取值范围**： - NONE：不配置。 - KAFKA_REPLICATOR_SOURCE：Kafka数据复制。 | | source_task | [SmartConnectTaskRespSourceConfig] object | **参数解释**： Smart Connect任务的源端配置。 | | sink_type | String | **参数解释**： Smart Connect任务的目标端类型。 **取值范围**： - NONE：不配置。 - OBS_SINK：转储。 | | sink_task | [SmartConnectTaskRespSinkConfig] object | **参数解释**： Smart Connect任务的目标端配置。 | | id | String | **参数解释**： Smart Connect任务的id。 **取值范围**： 不涉及。 | | status | String | **参数解释**： Smart Connect任务的状态。 **取值范围**： - PAUSED：暂停。 - RUNNING：运行中。 - WAITING：等待中。 - RESTARTING：重启中。 | | create_time | Long | **参数解释**： Smart Connect任务的创建时间。 **取值范围**： 不涉及。 | 表5SmartConnectTaskRespSourceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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时会显示） **取值范围**： 不涉及。 | 表6SmartConnectTaskRespSinkConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | consumer_strategy | String | **参数解释**： 转储启动偏移量。（仅目标端类型为OBS时会显示） **取值范围**： - latest：获取最新的数据。 - earliest：获取最早的数据。 | | destination_file_type | String | **参数解释**： 转储文件格式。当前只支持TEXT。（仅目标端类型为OBS时会显示） **取值范围**： TEXT。 | | deliver_time_interval | Integer | **参数解释**： 数据转储周期（秒）。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | obs_bucket_name | String | **参数解释**： 转储地址。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | obs_path | String | **参数解释**： 转储目录。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | partition_format | String | **参数解释**： 时间目录格式。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | record_delimiter | String | **参数解释**： 记录分行符。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | store_keys | Boolean | **参数解释**： 存储Key。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | obs_part_size | Integer | **参数解释**： 每个传输文件多大后就开始上传，单位为byte；默认值5242880。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | flush_size | Integer | **参数解释**： 刷写数量。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | timezone | String | **参数解释**： 时区。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | schema_generator_class | String | **参数解释**： schema_generator类，默认为"io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator"。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | partitioner_class | String | **参数解释**： partitioner类，默认"io.confluent.connect.storage.partitioner.TimeBasedPartitioner"。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | value_converter | String | **参数解释**： 值转换器，默认为"org.apache.kafka.connect.converters.ByteArrayConverter"。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | key_converter | String | **参数解释**： 键转换器，默认为"org.apache.kafka.connect.converters.ByteArrayConverter"。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | | kv_delimiter | String | **参数解释**： 键值分隔符，默认为":"。（仅目标端类型为OBS时会显示） **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks ``` #### 响应示例 **状态码：200** 查询Smart Connect任务列表成功。 ``` { "tasks" : [ { "task_name" : "smart-connect-1571576841", "topics" : "topic-1643449744", "source_task" : { "current_cluster_name" : "A", "cluster_name" : "B", "direction" : "pull", "bootstrap_servers" : "192.168.45.58:9092,192.168.44.1:9092,192.168.41.230:9092,192.168.43.112:9092", "instance_id" : "59f6d088-****-****-****-********", "consumer_strategy" : "earliest", "sync_consumer_offsets_enabled" : false, "rename_topic_enabled" : false, "provenance_header_enabled" : false, "security_protocol" : "PLAINTEXT", "sasl_mechanism" : "PLAIN", "user_name" : "", "topics_mapping" : "", "compression_type" : "none", "task_num" : 2, "replication_factor" : 3 }, "source_type" : "KAFKA_REPLICATOR_SOURCE", "sink_task" : null, "sink_type" : "NONE", "id" : "194917d0-****-****-****-********", "status" : "RUNNING", "create_time" : 1708427753133 }, { "task_name" : "smart-connect-1", "topics_regex" : "topic-obs*", "source_task" : null, "source_type" : "NONE", "sink_task" : { "consumer_strategy" : "earliest", "destination_file_type" : "TEXT", "obs_bucket_name" : "abcabc", "obs_path" : "obsTransfer-1810125534", "partition_format" : "yyyy/MM/dd/HH/mm", "record_delimiter" : "\\n", "deliver_time_interval" : 300, "obs_part_size" : 5242880, "flush_size" : 1000000, "timezone" : "Asia/Chongqing", "schema_generator_class" : "io.confluent.connect.storage.hive.schema.DefaultSchemaGenerator", "partitioner_class" : "io.confluent.connect.storage.partitioner.TimeBasedPartitioner", "value_converter" : "org.apache.kafka.connect.converters.ByteArrayConverter", "key_converter" : "org.apache.kafka.connect.converters.ByteArrayConverter", "store_keys" : false, "kv_delimiter" : ":" }, "sink_type" : "OBS_SINK", "id" : "3c0ac4d1-****-****-****-********", "status" : "RUNNING", "create_time" : 1708565483911 } ], "total_number" : 2, "max_tasks" : 18, "quota_tasks" : 18 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListConnectorTasksSolution { 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("")) .build(); ListConnectorTasksRequest request = new ListConnectorTasksRequest(); request.withInstanceId("{instance_id}"); try { ListConnectorTasksResponse response = client.listConnectorTasks(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListConnectorTasksRequest() request.instance_id = "{instance_id}" response = client.list_connector_tasks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.ListConnectorTasksRequest{} request.InstanceId = "{instance_id}" response, err := client.ListConnectorTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=ListConnectorTasks)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询Smart Connect任务列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。