tccli 3.0.1040.1__py2.py3-none-any.whl → 3.0.1042.1__py2.py3-none-any.whl

tccli/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1040.1'
+__version__ = '3.0.1042.1'

tccli/examples/cloudaudit/v20190319/DeleteAuditTrack.md

@@ -1,4 +1,4 @@
-**Example 1: 删除云审计跟踪集**
+**Example 1: 删除操作审计跟踪集**
 
 
 

tccli/examples/cloudaudit/v20190319/DescribeAuditTrack.md

@@ -1,4 +1,4 @@
-**Example 1: 查询云审计跟踪集详情**
+**Example 1: 查询操作审计跟踪集详情**
 
 
 

tccli/examples/cloudaudit/v20190319/DescribeAuditTracks.md

@@ -1,4 +1,4 @@
-**Example 1: 查询云审计跟踪集列表**
+**Example 1: 查询操作审计跟踪集列表**
 
 在控制台或者使用接口，查看已经创建的跟踪集列表
 

tccli/examples/cloudaudit/v20190319/DescribeEvents.md

@@ -1,6 +1,6 @@
-**Example 1: 查询云审计日志**
+**Example 1: 查询操作审计日志**
 
-查询云审计日志
+查询操作审计日志
 
 Input: 
 

tccli/examples/cloudaudit/v20190319/ModifyAuditTrack.md

@@ -1,4 +1,4 @@
-**Example 1: 修改云审计跟踪**
+**Example 1: 修改操作审计跟踪**
 
 
 

tccli/examples/dts/v20211206/ConfigureSubscribeJob.md

@@ -0,0 +1,36 @@
+**Example 1: 配置订阅**
+
+配置订阅一个cdb整实例的任务，其中db1.table1的数据根据id列值投递到不同的kafka分区，其他的数据根据表名投递
+
+Input: 
+
+```
+tccli dts ConfigureSubscribeJob --cli-unfold-argument  \
+    --SubscribeMode all \
+    --SubscribeId subs-5ft0e2nrc0 \
+    --KafkaConfig.DistributeRules.0.DbPattern db1 \
+    --KafkaConfig.DistributeRules.0.RuleType cols \
+    --KafkaConfig.DistributeRules.0.TablePattern table1 \
+    --KafkaConfig.DistributeRules.0.Columns id \
+    --KafkaConfig.NumberOfPartitions 8 \
+    --KafkaConfig.DefaultRuleType table \
+    --AccessType cdb \
+    --Protocol json \
+    --Endpoints.0.InstanceId cdb-kdxona7h \
+    --Endpoints.0.DatabaseRegion ap-guangzhou \
+    --Endpoints.0.EncryptConn Encrypted \
+    --Endpoints.0.User root \
+    --Endpoints.0.Password ****** \
+    --ExtraAttr.0.Value true \
+    --ExtraAttr.0.Key ProcessXA
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "abc"
+    }
+}
+```
+

tccli/examples/dts/v20211206/CreateConsumerGroup.md

@@ -0,0 +1,24 @@
+**Example 1: 创建消费组**
+
+创建消费组
+
+Input: 
+
+```
+tccli dts CreateConsumerGroup --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --ConsumerGroupName test \
+    --AccountName test \
+    --Password 123 \
+    --Description this is a test account
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "20461920-b18e-11ec-ae1a-cfe224f4f21f"
+    }
+}
+```
+

tccli/examples/dts/v20211206/CreateSubscribe.md

@@ -0,0 +1,28 @@
+**Example 1: 购买订阅任务**
+
+购买1个按量计费的mysql订阅任务
+
+Input: 
+
+```
+tccli dts CreateSubscribe --cli-unfold-argument  \
+    --Product mysql \
+    --PayType 1 \
+    --Count 1 \
+    --Tags.0.TagKey abc \
+    --Tags.0.TagValue abc \
+    --Name test-subscribe
+```
+
+Output: 
+```
+{
+    "Response": {
+        "SubscribeIds": [
+            "subs-b6x64o31tm"
+        ],
+        "RequestId": "xxxxxxxxxxxxxxx"
+    }
+}
+```
+

tccli/examples/dts/v20211206/CreateSubscribeCheckJob.md

@@ -0,0 +1,20 @@
+**Example 1: 启动一个订阅任务的校验**
+
+启动一个订阅任务的校验。任务必须已经成功掉用ConfigureSubscribe接口配置了所有的必要信息才能启动校验。
+
+Input: 
+
+```
+tccli dts CreateSubscribeCheckJob --cli-unfold-argument  \
+    --SubscribeId subs-l4d3a7izai
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "77501ba0-f097-11ed-ac7d-b1056735c0c8"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DeleteConsumerGroup.md

@@ -0,0 +1,22 @@
+**Example 1: 删除消费组**
+
+删除消费组
+
+Input: 
+
+```
+tccli dts DeleteConsumerGroup --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --ConsumerGroupName account-subs-9jyki7hniw-test \
+    --AccountName consumer-grp-subs-9jyki7hniw-test
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "bef6a6f0-f3b1-11ed-b987-7301347aa36f"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeConsumerGroups.md

@@ -0,0 +1,83 @@
+**Example 1: 获取数据订阅的消费组**
+
+获取数据订阅的消费组
+
+Input: 
+
+```
+tccli dts DescribeConsumerGroups --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Items": [
+            {
+                "Account": "account-subs-47damshnra-3",
+                "ConsumerGroupLag": 464948,
+                "ConsumerGroupName": "consumer-grp-subs-47damshnra-3",
+                "ConsumerGroupOffset": -1,
+                "ConsumerGroupState": "Dead",
+                "CreatedAt": "2022-03-25 17:31:31",
+                "Description": "sdfjo",
+                "Latency": 528268,
+                "PartitionAssignment": [],
+                "StateOfPartition": [
+                    {
+                        "ConsumerGroupLag": 464948,
+                        "ConsumerGroupOffset": -1,
+                        "Latency": 528268,
+                        "PartitionNo": 0
+                    }
+                ],
+                "UpdatedAt": "2022-03-25 17:31:31"
+            },
+            {
+                "Account": "account-subs-47damshnra-2",
+                "ConsumerGroupLag": 464948,
+                "ConsumerGroupName": "consumer-grp-subs-47damshnra-2",
+                "ConsumerGroupOffset": -1,
+                "ConsumerGroupState": "Dead",
+                "CreatedAt": "2022-03-22 17:34:31",
+                "Description": "sdfjo",
+                "Latency": 528268,
+                "PartitionAssignment": [],
+                "StateOfPartition": [
+                    {
+                        "ConsumerGroupLag": 464948,
+                        "ConsumerGroupOffset": -1,
+                        "Latency": 528268,
+                        "PartitionNo": 0
+                    }
+                ],
+                "UpdatedAt": "2022-03-22 17:34:31"
+            },
+            {
+                "Account": "account-subs-47damshnra-1",
+                "ConsumerGroupLag": 464948,
+                "ConsumerGroupName": "consumer-grp-subs-47damshnra-1",
+                "ConsumerGroupOffset": -1,
+                "ConsumerGroupState": "Dead",
+                "CreatedAt": "2022-03-04 15:14:18",
+                "Description": "sdfjo",
+                "Latency": 528268,
+                "PartitionAssignment": [],
+                "StateOfPartition": [
+                    {
+                        "ConsumerGroupLag": 464948,
+                        "ConsumerGroupOffset": -1,
+                        "Latency": 528268,
+                        "PartitionNo": 0
+                    }
+                ],
+                "UpdatedAt": "2022-03-04 15:14:18"
+            }
+        ],
+        "RequestId": "68c04ba0-b0d8-11ec-98f5-11f9ac4a2e37",
+        "TotalCount": 3
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeOffsetByTime.md

@@ -0,0 +1,39 @@
+**Example 1: 根据时间查询kafka中的checkpoint消息**
+
+查询KafkaTopic中指定时间前最近的checkpoint及其offset
+
+Input: 
+
+```
+tccli dts DescribeOffsetByTime --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --Time 2023-05-15 16:31:30
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Items": [
+            {
+                "Offset": 62856,
+                "PartitionNo": 0
+            },
+            {
+                "Offset": 62842,
+                "PartitionNo": 1
+            },
+            {
+                "Offset": 62842,
+                "PartitionNo": 2
+            },
+            {
+                "Offset": 62842,
+                "PartitionNo": 3
+            }
+        ],
+        "RequestId": "087e2780-f3bc-11ed-8dff-ff5f3734b02b"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeSubscribeCheckJob.md

@@ -0,0 +1,78 @@
+**Example 1: 查询订阅校验任务结果**
+
+查询订阅校验任务结果
+
+Input: 
+
+```
+tccli dts DescribeSubscribeCheckJob --cli-unfold-argument  \
+    --SubscribeId subs-l4d3a7izai
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Message": "success",
+        "Progress": 100,
+        "RequestId": "b048a800-f2fe-11ed-a211-5df19a912eab",
+        "Status": "success",
+        "StepAll": 5,
+        "StepNow": 5,
+        "Steps": [
+            {
+                "Errors": [],
+                "Percent": 100,
+                "Status": "finished",
+                "StepId": "ConnectDBCheck",
+                "StepName": "连接DB检查",
+                "StepNo": 1,
+                "Warnings": []
+            },
+            {
+                "Errors": [],
+                "Percent": 100,
+                "Status": "finished",
+                "StepId": "OptimizeCheck",
+                "StepName": "周边检查",
+                "StepNo": 2,
+                "Warnings": []
+            },
+            {
+                "Errors": [],
+                "Percent": 100,
+                "Status": "finished",
+                "StepId": "VersionCheck",
+                "StepName": "版本检查",
+                "StepNo": 3,
+                "Warnings": []
+            },
+            {
+                "Errors": [],
+                "Percent": 100,
+                "Status": "finished",
+                "StepId": "SrcPrivilegeCheck",
+                "StepName": "源实例权限检查",
+                "StepNo": 4,
+                "Warnings": [
+                    {
+                        "HelpDoc": "",
+                        "Message": "我们不需要能修改您源端数据的权限，请取消他们。例如，您的授权情况：GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE, CREATE ROLE, DROP ROLE ON *.* TO `root`@`%` WITH GRANT OPTION,GRANT APPLICATION_PASSWORD_ADMIN,ROLE_ADMIN,SHOW_ROUTINE,XA_RECOVER_ADMIN ON *.* TO `root`@`%` WITH GRANT OPTION 请参考 https://cloud.tencent.com/document/product/571/52412"
+                    }
+                ]
+            },
+            {
+                "Errors": [],
+                "Percent": 100,
+                "Status": "finished",
+                "StepId": "BinlogParamCheck",
+                "StepName": "binlog参数检查",
+                "StepNo": 5,
+                "Warnings": []
+            }
+        ],
+        "SubscribeId": "subs-9jyki7hniw"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeSubscribeDetail.md

@@ -0,0 +1,67 @@
+**Example 1: 查询订阅任务详情**
+
+
+
+Input: 
+
+```
+tccli dts DescribeSubscribeDetail --cli-unfold-argument  \
+    --SubscribeId subs-0b2up6hk4u
+```
+
+Output: 
+```
+{
+    "Response": {
+        "Region": "ap-guangzhou",
+        "AccessType": "cdb",
+        "AutoRenewFlag": 0,
+        "Broker": "guangzhoutest-kafka-3.cdb-dts.tencentcs.com.cn:32339",
+        "CreateTime": "2023-12-06 14:31:27",
+        "Endpoints": [
+            {
+                "DatabaseRegion": "ap-guangzhou",
+                "EncryptConn": "UnEncrypted",
+                "InstanceId": "cdb-kdxona7h",
+                "User": "root"
+            }
+        ],
+        "ExpireTime": "0000-00-00 00:00:00",
+        "InstanceId": "cdb-kdxona7h",
+        "InstanceStatus": "running",
+        "IsolateTime": "0000-00-00 00:00:00",
+        "KafkaConfig": {
+            "DistributeRules": [
+                {
+                    "DbPattern": "db1",
+                    "RuleType": "cols",
+                    "TablePattern": "table1",
+                    "Columns": [
+                        "id"
+                    ]
+                },
+                {
+                    "DbPattern": ".*",
+                    "RuleType": "table",
+                    "TablePattern": ".*",
+                    "Columns": null
+                }
+            ],
+            "NumberOfPartitions": 8
+        },
+        "ModifyTime": "2023-12-06 14:33:47",
+        "OfflineTime": "0000-00-00 00:00:00",
+        "PayType": 0,
+        "Product": "mysql",
+        "Protocol": "json",
+        "Status": "normal",
+        "SubsStatus": "running",
+        "SubscribeId": "subs-0b2up6hk4u",
+        "SubscribeName": "test",
+        "SubscribeMode": "all",
+        "Topic": "topic-subs-0b2up6hk4u-cdb-kdxona7h",
+        "RequestId": "7bd11a40-9406-11ee-9689-216abbbe2107"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeSubscribeJobs.md

@@ -0,0 +1,52 @@
+**Example 1: 查询订阅任务列表**
+
+
+
+Input: 
+
+```
+tccli dts DescribeSubscribeJobs --cli-unfold-argument  \
+    --Offset 0 \
+    --Limit 10
+```
+
+Output: 
+```
+{
+    "Response": {
+        "TotalCount": 1,
+        "Items": [
+            {
+                "SubscribeId": "subs-5ft0e2nrc0",
+                "SubscribeName": "name-5ft0e2nrc0",
+                "Topic": "topic-subs-5ft0e2nrc0-cdb-kdxona7h",
+                "Product": "mysql",
+                "InstanceId": "cdb-kdxona7h",
+                "InstanceStatus": "running",
+                "Status": "normal",
+                "SubsStatus": "running",
+                "ModifyTime": "2023-10-01 12:00:00",
+                "CreateTime": "2023-09-01 12:00:00",
+                "IsolateTime": "0000-00-00 00:00:00",
+                "ExpireTime": "2023-11-01 12:00:00",
+                "OfflineTime": "0000-00-00 00:00:00",
+                "PayType": 0,
+                "AutoRenewFlag": 0,
+                "Region": "ap-guangzhou",
+                "AccessType": "cdb",
+                "Endpoints": [
+                    {
+                        "DatabaseRegion": "ap-guangzhou",
+                        "InstanceId": "cdb-kdxona7h",
+                        "EncryptConn": "Encrypted",
+                        "User": "root"
+                    }
+                ],
+                "SubscribeVersion": "kafka"
+            }
+        ],
+        "RequestId": "cd6eebd0-9405-11ee-9689-216abbbe2107"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DescribeSubscribeReturnable.md

@@ -0,0 +1,22 @@
+**Example 1: 查询订阅实例是否可以退换**
+
+查询订阅实例是否可以退换
+
+Input: 
+
+```
+tccli dts DescribeSubscribeReturnable --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw
+```
+
+Output: 
+```
+{
+    "Response": {
+        "IsReturnable": true,
+        "ReturnFailMessage": "",
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+

tccli/examples/dts/v20211206/DestroyIsolatedSubscribe.md

@@ -0,0 +1,20 @@
+**Example 1: 下线已隔离的数据订阅实例**
+
+订阅任务已经隔离，立即发起下线任务
+
+Input: 
+
+```
+tccli dts DestroyIsolatedSubscribe --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+

tccli/examples/dts/v20211206/IsolateSubscribe.md

@@ -0,0 +1,20 @@
+**Example 1: 隔离订阅任务**
+
+隔离订阅任务
+
+Input: 
+
+```
+tccli dts IsolateSubscribe --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+

tccli/examples/dts/v20211206/ModifyConsumerGroupDescription.md

@@ -0,0 +1,23 @@
+**Example 1: 修改消费组备注**
+
+修改消费组备注
+
+Input: 
+
+```
+tccli dts ModifyConsumerGroupDescription --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --AccountName account-subs-9jyki7hniw-1 \
+    --ConsumerGroupName consumer-grp-subs-9jyki7hniw-1 \
+    --Description this is a test group
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "bef6a6f0-f3b1-11ed-b987-7301347aa36f"
+    }
+}
+```
+

tccli/examples/dts/v20211206/ModifyConsumerGroupPassword.md

@@ -0,0 +1,24 @@
+**Example 1: 修改消费组密码**
+
+修改消费组密码
+
+Input: 
+
+```
+tccli dts ModifyConsumerGroupPassword --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --AccountName account-subs-9jyki7hniw-1 \
+    --ConsumerGroupName consumer-grp-subs-9jyki7hniw-1 \
+    --OldPassword 123 \
+    --NewPassword asdiouy09
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "bef6a6f0-f3b1-11ed-b987-7301347aa36f"
+    }
+}
+```
+

tccli/examples/dts/v20211206/ModifySubscribeAutoRenewFlag.md

@@ -0,0 +1,21 @@
+**Example 1: 修改数据订阅自动续费标识**
+
+将一个包年包月的订阅任务从不自动续费改为自动续费
+
+Input: 
+
+```
+tccli dts ModifySubscribeAutoRenewFlag --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --AutoRenewFlag 1
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+

tccli/examples/dts/v20211206/ModifySubscribeName.md

@@ -0,0 +1,21 @@
+**Example 1: 修改数据订阅实例的名称**
+
+修改数据订阅实例的名称
+
+Input: 
+
+```
+tccli dts ModifySubscribeName --cli-unfold-argument  \
+    --SubscribeId subs-9jyki7hniw \
+    --SubscribeName subscribe-test
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+

tccli/examples/dts/v20211206/ModifySubscribeObjects.md

@@ -0,0 +1,21 @@
+**Example 1: 修改数据订阅通道的订阅规则**
+
+修改数据订阅的订阅规则，如添加或者移除某些库表
+
+Input: 
+
+```
+tccli dts ModifySubscribeObjects --cli-unfold-argument  \
+    --SubscribeId subs-ieuwi83j2e \
+    --SubscribeObjectType 0
+```
+
+Output: 
+```
+{
+    "Response": {
+        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
+    }
+}
+```
+