feat auto update sdk

Author: liyan.90210

Changelog

@@ -1,5 +1,8 @@
 ### Change log
 
+2026-01-08 Bumped to version v1.0.213
+- Updated apis for tls
+
 2025-12-25 Bumped to version v1.0.212
 - Updated apis for tls
 

README.EN.MD

@@ -0,0 +1,77 @@
+English | [中文](README.md)
+
+<h1 align="center"><img src="https://iam.volccdn.com/obj/volcengine-public/pic/volcengine-icon.png"></h1>
+<h1 align="center">Volcengine SDK for Python</h1>
+
+Welcome to Volcengine SDK for Python. This document explains how to obtain and use the SDK.
+
+## Prerequisites
+
+### Enable the service
+
+Make sure the service you want to access is enabled. Go to the [Volcengine Console](https://console.volcengine.com/), select the service from the left navigation (or search it from the top bar), and complete the activation process in the service console.
+
+### Obtain security credentials
+
+Access Key is the credential used to access Volcengine services. It consists of Access Key ID (AK) and Secret Access Key (SK).
+
+Log in to the [Volcengine Console](https://console.volcengine.com/), then go to [IAM](https://console.volcengine.com/iam) -> [Access Keys](https://console.volcengine.com/iam/keymanage/) to create and manage your Access Keys. For more information, see the [Access Key documentation](https://www.volcengine.com/docs/6291/65568).
+
+### Environment check
+
+Python version must be **3.7** or later.
+
+## Install
+
+Install the SDK via pip:
+
+```bash
+pip install --user volcengine
+```
+
+If `volcengine` is already installed, upgrade it with:
+
+```bash
+pip install --upgrade volcengine
+```
+
+## Configuration
+
+### Credential configuration
+
+Volcengine SDK for Python supports the following credential loading methods.
+
+*Note: Replace `Your AK` and `Your SK` in the code with your actual AK and SK.*
+
+**Method 1**: Set AK/SK on the client **(recommended)**
+
+```python
+iam_service = IamService()
+iam_service.set_ak('Your AK')
+iam_service.set_sk('Your SK')
+```
+
+**Method 2**: Load AK/SK from environment variables
+
+```bash
+VOLC_ACCESSKEY="Your AK"
+VOLC_SECRETKEY="Your SK"
+```
+
+**Method 3**: Load AK/SK from a file under HOME
+
+Add the following content to `~/.volc/config`:
+
+```json
+{
+  "ak": "Your AK",
+  "sk": "Your SK"
+}
+```
+
+## Other resources
+
+### Some service directories and examples
+
+- [Visual Intelligence](volcengine/visual/README.md)
+- [NLP](volcengine/nlp/README.md)

README.md

@@ -1,3 +1,5 @@
+中文 | [English](README.EN.MD)
+
 <h1 align="center"><img src="https://iam.volccdn.com/obj/volcengine-public/pic/volcengine-icon.png"></h1>
 <h1 align="center">火山引擎SDK for Python</h1> 
 欢迎使用火山引擎SDK for Python，本文档为您介绍如何获取及调用SDK。

volcengine/__init__.py

@@ -1,2 +1,2 @@
 # coding:utf-8
-VERSION='v1.0.212'
+VERSION='v1.0.213'

volcengine/example/tls/example_etl.py

@@ -0,0 +1,88 @@
+# coding=utf-8
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+import os
+import time
+
+from volcengine.tls.TLSService import TLSService
+from volcengine.tls.tls_requests import *
+
+
+if __name__ == "__main__":
+    # 初始化客户端，推荐通过环境变量动态获取火山引擎密钥等身份认证信息，
+    # 以免AccessKey硬编码引发数据安全风险。详细说明请参考
+    # https://www.volcengine.com/docs/6470/1166455
+    # 使用STS时，ak和sk均使用临时密钥，且设置VOLCENGINE_TOKEN；不使用STS时，VOLCENGINE_TOKEN部分传空
+    endpoint = os.environ["VOLCENGINE_ENDPOINT"]
+    region = os.environ["VOLCENGINE_REGION"]
+    access_key_id = os.environ["VOLCENGINE_ACCESS_KEY_ID"]
+    access_key_secret = os.environ["VOLCENGINE_ACCESS_KEY_SECRET"]
+
+    # 实例化TLS客户端
+    tls_service = TLSService(endpoint, access_key_id, access_key_secret, region)
+    now = str(int(time.time()))
+
+    # 创建日志项目
+    create_project_request = CreateProjectRequest(project_name="project-name-" + now, region=region,
+                                                  description="project-description")
+    create_project_response = tls_service.create_project(create_project_request)
+    project_id = create_project_response.get_project_id()
+
+    # 创建源日志主题
+    create_source_topic_request = CreateTopicRequest(
+        topic_name="source-topic-name-" + now,
+        project_id=project_id,
+        ttl=3650,
+        description="source-topic-description",
+        shard_count=2,
+    )
+    create_source_topic_response = tls_service.create_topic(create_source_topic_request)
+    source_topic_id = create_source_topic_response.get_topic_id()
+
+    # 创建目标日志主题
+    create_target_topic_request = CreateTopicRequest(
+        topic_name="target-topic-name-" + now,
+        project_id=project_id,
+        ttl=3650,
+        description="target-topic-description",
+        shard_count=2,
+    )
+    create_target_topic_response = tls_service.create_topic(create_target_topic_request)
+    target_topic_id = create_target_topic_response.get_topic_id()
+
+    # 创建ETL任务
+    # 请根据您的需要，填写相关参数
+    # CreateETLTask API的请求参数规范请参阅相关文档
+    create_etl_task_request = CreateETLTaskRequest(
+        dsl_type="NORMAL",
+        name="etl-task-name-" + now,
+        description="etl-task-description",
+        enable=True,
+        source_topic_id=source_topic_id,
+        script='f_set("key", "value")',
+        task_type="Resident",
+        target_resources=[
+            {
+                "alias": "test",
+                "topic_id": target_topic_id,
+                "region": region
+            }
+        ]
+    )
+    create_etl_task_response = tls_service.create_etl_task(create_etl_task_request)
+    etl_task_id = create_etl_task_response.get_task_id()
+
+    print(f"ETL Task created successfully, task_id: {etl_task_id}")
+
+    # 删除日志主题
+    delete_source_topic_request = DeleteTopicRequest(source_topic_id)
+    tls_service.delete_topic(delete_source_topic_request)
+
+    delete_target_topic_request = DeleteTopicRequest(target_topic_id)
+    tls_service.delete_topic(delete_target_topic_request)
+
+    # 删除日志项目
+    delete_project_request = DeleteProjectRequest(project_id=project_id)
+    tls_service.delete_project(delete_project_request)

volcengine/example/tls/example_schedule_sql_task.py

@@ -0,0 +1,109 @@
+# coding=utf-8
+import os
+import time
+import uuid
+
+from volcengine.tls.TLSService import TLSService
+from volcengine.tls.tls_requests import *
+
+
+if __name__ == "__main__":
+    # 初始化客户端，需要设置AccessKey ID/AccessKey Secret，以及服务地域
+    endpoint = os.environ["VOLCENGINE_ENDPOINT"]
+    region = os.environ["VOLCENGINE_REGION"]
+    access_key_id = os.environ["VOLCENGINE_ACCESS_KEY_ID"]
+    access_key_secret = os.environ["VOLCENGINE_ACCESS_KEY_SECRET"]
+
+    # 创建TLS客户端
+    tls_service = TLSService(endpoint, access_key_id, access_key_secret, region)
+
+    # 创建项目和主题用于测试
+    project_name = f"tls-python-sdk-schedule-project-{uuid.uuid4().hex}"
+    source_topic_name = f"tls-python-sdk-schedule-source-topic-{uuid.uuid4().hex}"
+    dest_topic_name = f"tls-python-sdk-schedule-dest-topic-{uuid.uuid4().hex}"
+
+    # 创建项目
+    create_project_request = CreateProjectRequest(
+        project_name=project_name,
+        region=region,
+    )
+    create_project_response = tls_service.create_project(create_project_request)
+    project_id = create_project_response.get_project_id()
+    print(f"Created project: {project_id}")
+
+    # 创建源主题
+    create_source_topic_request = CreateTopicRequest(
+        project_id=project_id,
+        topic_name=source_topic_name,
+        shard_count=1,
+        ttl=1,
+    )
+    create_source_topic_response = tls_service.create_topic(create_source_topic_request)
+    source_topic_id = create_source_topic_response.get_topic_id()
+    print(f"Created source topic: {source_topic_id}")
+
+    # 创建目标主题
+    create_dest_topic_request = CreateTopicRequest(
+        project_id=project_id,
+        topic_name=dest_topic_name,
+        shard_count=1,
+        ttl=1,
+    )
+    create_dest_topic_response = tls_service.create_topic(create_dest_topic_request)
+    dest_topic_id = create_dest_topic_response.get_topic_id()
+    print(f"Created dest topic: {dest_topic_id}")
+
+    # 为源主题创建索引
+    create_index_request = CreateIndexRequest(
+        topic_id=source_topic_id,
+        full_text=FullTextInfo(
+            delimiter=",; ",
+            case_sensitive=False,
+            include_chinese=False,
+        ),
+    )
+    create_index_response = tls_service.create_index(create_index_request)
+    print(f"Created index for source topic: {create_index_response.get_request_id()}")
+
+    # 创建定时SQL任务
+    current_time = int(time.time())
+    task_name = f"tls-python-sdk-schedule-task-{uuid.uuid4().hex}"
+    create_schedule_sql_task_request = CreateScheduleSqlTaskRequest(
+        task_name=task_name,
+        topic_id=source_topic_id,
+        dest_topic_id=dest_topic_id,
+        process_start_time=current_time + 3600,  # 1小时后开始
+        process_time_window="@m-15m,@m",
+        query="* | select count(*) as count",
+        request_cycle=RequestCycle(
+            cycle_type="Period",
+            time=60,  # 每60分钟执行一次
+        ),
+        status=0,  # 关闭任务，后续需手动启动
+        description="测试定时SQL任务",
+        process_sql_delay=60,
+    )
+
+    create_schedule_sql_task_response = tls_service.create_schedule_sql_task(
+        create_schedule_sql_task_request)
+    task_id = create_schedule_sql_task_response.get_task_id()
+    print(f"Created schedule SQL task: {task_id}")
+
+    # 清理资源
+    print("Cleaning up resources...")
+    # 删除目标主题
+    delete_dest_topic_request = DeleteTopicRequest(topic_id=dest_topic_id)
+    tls_service.delete_topic(delete_dest_topic_request)
+    print(f"Deleted dest topic: {dest_topic_id}")
+
+    # 删除源主题
+    delete_source_topic_request = DeleteTopicRequest(topic_id=source_topic_id)
+    tls_service.delete_topic(delete_source_topic_request)
+    print(f"Deleted source topic: {source_topic_id}")
+
+    # 删除项目
+    delete_project_request = DeleteProjectRequest(project_id=project_id)
+    tls_service.delete_project(delete_project_request)
+    print(f"Deleted project: {project_id}")
+
+    print("Example completed successfully!")