文档中心

日志服务

请输入

数据导入

ModifyImportTask

调用 ModifyImportTask 接口修改指定的数据导入任务。

注意事项

处于重启中、导入完成或停止中的任务，不支持修改。

请求说明

请求方式：PUT

请求地址：https://{tls-endpoint}/ModifyImportTask

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
Description	String	否	this is a task	数据导入任务的描述。
ImportSourceInfo	Object of ImportSourceInfo	是	/	数据导入任务的导入源端信息。
ProjectID	String	否	fc69****	用于存储数据的日志项目 ID。
SourceType	String	是	kafka	导入源端类型。 tos：导入 TOS 数据。 kafka：导入 Kafka 数据。仅支持修改 Kafka 数据类型。
Status	Integer	是	0	数据导入任务的状态。 0：导入中。 1：导入完成。 2：导入异常。 3：停止中。 4：已停止。 5：重启中。
TaskId	String	是	841c3908-09e8-4811-bdb4-2b77dd4****	数据导入任务 ID。
TaskName	String	是	task-name-1	数据导入任务名称。
TopicID	String	是	fa************	用于存储数据的日志主题 ID。

ImportSourceInfo

参数	类型	是否必选	示例值	描述
KafkaSourceInfo	Object of KafkaSourceInfo	否	/	Kafka 导入源端信息。当 sourceType 为 kafka 时，KafkaSourceInfo字段为必填。

KafkaSourceInfo

参数	类型	是否必选	示例值	描述
host	String	否	kafka-cnngc7an0qpv****.kafka.ivolces.com:9092	不同类型的 Kafka 集群对应的服务地址不同，详细说明如下：火山引擎消息队列 Kafka 版：Kafka 实例的接入点，详细说明请参考查看接入点。如果 Kafka 实例与日志服务 Project 属于同一地域，可使用私网访问，否则需使用公网访问。自建的 Kafka 集群：Kafka Broker 的 IP 地址和端口号或者域名和端口号。仅支持公网访问。多个服务地址之间需使用半角逗号（,）分隔。
group	String	否	mygroup	Kafka 消费组。如果不填，系统将自动创建 Kafka 消费组。
topic	String	否	test	Kafka Topic 名称。多个 Kafka Topic 之间应使用半角逗号（,）分隔。
encode	String	否	UTF-8	数据的编码格式。可选值包括 UTF-8、GBK。
password	String	否	/	用于身份认证的 Kafka SASL 用户密码。
protocol	String	否	plaintext	安全传输协议，可选值包括 plaintext、sasl_ssl、ssl 和 sasl_plaintext。
username	String	否	/	用于身份认证的 Kafka SASL 用户名。
mechanism	String	否	PLAIN	密码认证机制，可选值包括 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512。
instance_id	String	否	kafka-cnngbnntswg1****	当您使用的是火山引擎消息队列 Kafka 版时，应设置为 Kafka 实例 ID。
is_need_auth	Boolean	否	true	是否开启鉴权。如果您使用的是公网服务地址，建议开启鉴权。
initial_offset	Integer	否	/	数据导入的起始位置。可选值： 0：最早时间，即从指定的 Kafka Topic 中的第一条数据开始导入。 1：最近时间，即从指定的 Kafka Topic 中最新生成的数据开始导入。
time_source_default	Integer	否	/	指定日志时间。可选值： 0：使用 Kafka 消息时间戳。 1：使用系统当前时间。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

PUT https://{tls-endpoint}/ModifyImportTask HTTP/1.1​
Content-Type: application/json​
{​
	"ProjectID": "d1987480-*****-b403-4d087a7b866a",​
	"TopicID": "fbef6560-******-83b5-4c6e345e3bb8",​
    "TaskId": "53f69c58-******-8b4c-978eeaf6f8da",​
	"TaskName": "import-kafka",​
	"SourceType": "kafka",​
    "Status": 5,​
	"Description": "kafka-import desc",​
	"ImportSourceInfo": {​
		"KafkaSourceInfo": {​
                "host": "10.249.**.*:9192",​
                "topic": "app",​
                "group": "TLS-f32f3e5f-c5b0-4a39-****-5c0e304da293",​
                "initial_offset": 0,​
                "encode": "UTF-8",​
                "time_source_default": 0,​
                "is_need_auth": false,​
                "protocol": "",​
                "mechanism": "",​
                "username": "",​
                "password": ""​
            }​
	},​
    "TargetInfo":{​
        "Region": "cn-shanghai",​
        "LogType": "json_log"​
    }​
}​

返回示例

Content-Type: application/json; charset=utf-8​
{}​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.04.17 15:43:22

这个页面对您有帮助吗？

有用

无用