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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cloudaudit/v20190319/DeleteAuditTrack.md +1 -1
  3. tccli/examples/cloudaudit/v20190319/DescribeAuditTrack.md +1 -1
  4. tccli/examples/cloudaudit/v20190319/DescribeAuditTracks.md +1 -1
  5. tccli/examples/cloudaudit/v20190319/DescribeEvents.md +2 -2
  6. tccli/examples/cloudaudit/v20190319/ModifyAuditTrack.md +1 -1
  7. tccli/examples/dts/v20211206/ConfigureSubscribeJob.md +36 -0
  8. tccli/examples/dts/v20211206/CreateConsumerGroup.md +24 -0
  9. tccli/examples/dts/v20211206/CreateSubscribe.md +28 -0
  10. tccli/examples/dts/v20211206/CreateSubscribeCheckJob.md +20 -0
  11. tccli/examples/dts/v20211206/DeleteConsumerGroup.md +22 -0
  12. tccli/examples/dts/v20211206/DescribeConsumerGroups.md +83 -0
  13. tccli/examples/dts/v20211206/DescribeOffsetByTime.md +39 -0
  14. tccli/examples/dts/v20211206/DescribeSubscribeCheckJob.md +78 -0
  15. tccli/examples/dts/v20211206/DescribeSubscribeDetail.md +67 -0
  16. tccli/examples/dts/v20211206/DescribeSubscribeJobs.md +52 -0
  17. tccli/examples/dts/v20211206/DescribeSubscribeReturnable.md +22 -0
  18. tccli/examples/dts/v20211206/DestroyIsolatedSubscribe.md +20 -0
  19. tccli/examples/dts/v20211206/IsolateSubscribe.md +20 -0
  20. tccli/examples/dts/v20211206/ModifyConsumerGroupDescription.md +23 -0
  21. tccli/examples/dts/v20211206/ModifyConsumerGroupPassword.md +24 -0
  22. tccli/examples/dts/v20211206/ModifySubscribeAutoRenewFlag.md +21 -0
  23. tccli/examples/dts/v20211206/ModifySubscribeName.md +21 -0
  24. tccli/examples/dts/v20211206/ModifySubscribeObjects.md +21 -0
  25. tccli/examples/dts/v20211206/ResetConsumerGroupOffset.md +25 -0
  26. tccli/examples/dts/v20211206/ResetSubscribe.md +20 -0
  27. tccli/examples/dts/v20211206/ResumeSubscribe.md +20 -0
  28. tccli/examples/dts/v20211206/StartSubscribe.md +20 -0
  29. tccli/examples/essbasic/v20210526/ChannelCreatePrepareFlow.md +56 -0
  30. tccli/examples/ocr/v20181119/VerifyOfdVatInvoiceOCR.md +6 -1
  31. tccli/services/car/v20220110/api.json +2 -2
  32. tccli/services/clb/v20180317/api.json +3 -1
  33. tccli/services/cloudaudit/v20190319/api.json +61 -27
  34. tccli/services/cloudaudit/v20190319/examples.json +6 -6
  35. tccli/services/cvm/v20170312/api.json +2 -2
  36. tccli/services/cynosdb/v20190107/api.json +118 -0
  37. tccli/services/dnspod/v20210323/api.json +10 -0
  38. tccli/services/dts/dts_client.py +1008 -160
  39. tccli/services/dts/v20211206/api.json +4354 -1796
  40. tccli/services/dts/v20211206/examples.json +176 -0
  41. tccli/services/ess/v20201111/api.json +12 -12
  42. tccli/services/essbasic/v20210526/api.json +3 -3
  43. tccli/services/essbasic/v20210526/examples.json +1 -1
  44. tccli/services/monitor/v20180724/api.json +13 -8
  45. tccli/services/ocr/v20181119/api.json +1 -1
  46. tccli/services/ocr/v20181119/examples.json +1 -1
  47. tccli/services/rum/rum_client.py +12 -171
  48. tccli/services/rum/v20210622/api.json +0 -170
  49. tccli/services/rum/v20210622/examples.json +0 -24
  50. tccli/services/trtc/v20190722/api.json +1 -1
  51. tccli/services/vpc/v20170312/api.json +1 -0
  52. {tccli-3.0.1040.1.dist-info → tccli-3.0.1042.1.dist-info}/METADATA +2 -2
  53. {tccli-3.0.1040.1.dist-info → tccli-3.0.1042.1.dist-info}/RECORD +56 -34
  54. {tccli-3.0.1040.1.dist-info → tccli-3.0.1042.1.dist-info}/WHEEL +0 -0
  55. {tccli-3.0.1040.1.dist-info → tccli-3.0.1042.1.dist-info}/entry_points.txt +0 -0
  56. {tccli-3.0.1040.1.dist-info → tccli-3.0.1042.1.dist-info}/license_files/LICENSE +0 -0
@@ -8,6 +8,14 @@
8
8
  "title": "完成数据迁移任务"
9
9
  }
10
10
  ],
11
+ "ConfigureSubscribeJob": [
12
+ {
13
+ "document": "配置订阅一个cdb整实例的任务,其中db1.table1的数据根据id列值投递到不同的kafka分区,其他的数据根据表名投递",
14
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ConfigureSubscribeJob\n<公共请求参数>\n\n{\n \"SubscribeMode\": \"all\",\n \"SubscribeId\": \"subs-5ft0e2nrc0\",\n \"KafkaConfig\": {\n \"DistributeRules\": [\n {\n \"DbPattern\": \"db1\",\n \"RuleType\": \"cols\",\n \"TablePattern\": \"table1\",\n \"Columns\": [\n \"id\"\n ]\n }\n ],\n \"NumberOfPartitions\": 8,\n \"DefaultRuleType\": \"table\"\n },\n \"AccessType\": \"cdb\",\n \"Protocol\": \"json\",\n \"Endpoints\": [\n {\n \"InstanceId\": \"cdb-kdxona7h\",\n \"DatabaseRegion\": \"ap-guangzhou\",\n \"EncryptConn\": \"Encrypted\",\n \"User\": \"root\",\n \"Password\": \"******\"\n }\n ],\n \"ExtraAttr\": [\n {\n \"Value\": \"true\",\n \"Key\": \"ProcessXA\"\n }\n ]\n}",
15
+ "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
16
+ "title": "配置订阅"
17
+ }
18
+ ],
11
19
  "ConfigureSyncJob": [
12
20
  {
13
21
  "document": "配置一个同步整库的同步任务",
@@ -54,6 +62,14 @@
54
62
  "title": "创建一致性校验任务"
55
63
  }
56
64
  ],
65
+ "CreateConsumerGroup": [
66
+ {
67
+ "document": "创建消费组",
68
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumerGroup\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"ConsumerGroupName\": \"test\",\n \"AccountName\": \"test\",\n \"Password\": \"123\",\n \"Description\": \"this is a test account\"\n}",
69
+ "output": "{\n \"Response\": {\n \"RequestId\": \"20461920-b18e-11ec-ae1a-cfe224f4f21f\"\n }\n}",
70
+ "title": "创建消费组"
71
+ }
72
+ ],
57
73
  "CreateMigrateCheckJob": [
58
74
  {
59
75
  "document": "",
@@ -78,6 +94,22 @@
78
94
  "title": "创建修改对象的校验任务"
79
95
  }
80
96
  ],
97
+ "CreateSubscribe": [
98
+ {
99
+ "document": "购买1个按量计费的mysql订阅任务",
100
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSubscribe\n<公共请求参数>\n\n{\n \"Product\": \"mysql\",\n \"PayType\": 1,\n \"Count\": 1,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"Name\": \"test-subscribe\"\n}",
101
+ "output": "{\n \"Response\": {\n \"SubscribeIds\": [\n \"subs-b6x64o31tm\"\n ],\n \"RequestId\": \"xxxxxxxxxxxxxxx\"\n }\n}",
102
+ "title": "购买订阅任务"
103
+ }
104
+ ],
105
+ "CreateSubscribeCheckJob": [
106
+ {
107
+ "document": "启动一个订阅任务的校验。任务必须已经成功掉用ConfigureSubscribe接口配置了所有的必要信息才能启动校验。",
108
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSubscribeCheckJob\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-l4d3a7izai\"\n}",
109
+ "output": "{\n \"Response\": {\n \"RequestId\": \"77501ba0-f097-11ed-ac7d-b1056735c0c8\"\n }\n}",
110
+ "title": "启动一个订阅任务的校验"
111
+ }
112
+ ],
81
113
  "CreateSyncJob": [
82
114
  {
83
115
  "document": "创建一个同步任务",
@@ -94,6 +126,14 @@
94
126
  "title": "删除一致性校验任务"
95
127
  }
96
128
  ],
129
+ "DeleteConsumerGroup": [
130
+ {
131
+ "document": "删除消费组",
132
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteConsumerGroup\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"ConsumerGroupName\": \"account-subs-9jyki7hniw-test\",\n \"AccountName\": \"consumer-grp-subs-9jyki7hniw-test\"\n}",
133
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bef6a6f0-f3b1-11ed-b987-7301347aa36f\"\n }\n}",
134
+ "title": "删除消费组"
135
+ }
136
+ ],
97
137
  "DescribeCheckSyncJobResult": [
98
138
  {
99
139
  "document": "任务发起校验为异步操作,需要通过此接口查询同步任务校验结果",
@@ -118,6 +158,14 @@
118
158
  "title": "查询一致性校验任务列表"
119
159
  }
120
160
  ],
161
+ "DescribeConsumerGroups": [
162
+ {
163
+ "document": "获取数据订阅的消费组",
164
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerGroups\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\"\n}",
165
+ "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"Account\": \"account-subs-47damshnra-3\",\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupName\": \"consumer-grp-subs-47damshnra-3\",\n \"ConsumerGroupOffset\": -1,\n \"ConsumerGroupState\": \"Dead\",\n \"CreatedAt\": \"2022-03-25 17:31:31\",\n \"Description\": \"sdfjo\",\n \"Latency\": 528268,\n \"PartitionAssignment\": [],\n \"StateOfPartition\": [\n {\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupOffset\": -1,\n \"Latency\": 528268,\n \"PartitionNo\": 0\n }\n ],\n \"UpdatedAt\": \"2022-03-25 17:31:31\"\n },\n {\n \"Account\": \"account-subs-47damshnra-2\",\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupName\": \"consumer-grp-subs-47damshnra-2\",\n \"ConsumerGroupOffset\": -1,\n \"ConsumerGroupState\": \"Dead\",\n \"CreatedAt\": \"2022-03-22 17:34:31\",\n \"Description\": \"sdfjo\",\n \"Latency\": 528268,\n \"PartitionAssignment\": [],\n \"StateOfPartition\": [\n {\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupOffset\": -1,\n \"Latency\": 528268,\n \"PartitionNo\": 0\n }\n ],\n \"UpdatedAt\": \"2022-03-22 17:34:31\"\n },\n {\n \"Account\": \"account-subs-47damshnra-1\",\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupName\": \"consumer-grp-subs-47damshnra-1\",\n \"ConsumerGroupOffset\": -1,\n \"ConsumerGroupState\": \"Dead\",\n \"CreatedAt\": \"2022-03-04 15:14:18\",\n \"Description\": \"sdfjo\",\n \"Latency\": 528268,\n \"PartitionAssignment\": [],\n \"StateOfPartition\": [\n {\n \"ConsumerGroupLag\": 464948,\n \"ConsumerGroupOffset\": -1,\n \"Latency\": 528268,\n \"PartitionNo\": 0\n }\n ],\n \"UpdatedAt\": \"2022-03-04 15:14:18\"\n }\n ],\n \"RequestId\": \"68c04ba0-b0d8-11ec-98f5-11f9ac4a2e37\",\n \"TotalCount\": 3\n }\n}",
166
+ "title": "获取数据订阅的消费组"
167
+ }
168
+ ],
121
169
  "DescribeMigrateDBInstances": [
122
170
  {
123
171
  "document": "查询迁移实例列表",
@@ -158,6 +206,46 @@
158
206
  "title": "查询修改对象校验任务的结果"
159
207
  }
160
208
  ],
209
+ "DescribeOffsetByTime": [
210
+ {
211
+ "document": "查询KafkaTopic中指定时间前最近的checkpoint及其offset",
212
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeOffsetByTime\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"Time\": \"2023-05-15 16:31:30\"\n}",
213
+ "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"Offset\": 62856,\n \"PartitionNo\": 0\n },\n {\n \"Offset\": 62842,\n \"PartitionNo\": 1\n },\n {\n \"Offset\": 62842,\n \"PartitionNo\": 2\n },\n {\n \"Offset\": 62842,\n \"PartitionNo\": 3\n }\n ],\n \"RequestId\": \"087e2780-f3bc-11ed-8dff-ff5f3734b02b\"\n }\n}",
214
+ "title": "根据时间查询kafka中的checkpoint消息"
215
+ }
216
+ ],
217
+ "DescribeSubscribeCheckJob": [
218
+ {
219
+ "document": "查询订阅校验任务结果",
220
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubscribeCheckJob\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-l4d3a7izai\"\n}",
221
+ "output": "{\n \"Response\": {\n \"Message\": \"success\",\n \"Progress\": 100,\n \"RequestId\": \"b048a800-f2fe-11ed-a211-5df19a912eab\",\n \"Status\": \"success\",\n \"StepAll\": 5,\n \"StepNow\": 5,\n \"Steps\": [\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"Status\": \"finished\",\n \"StepId\": \"ConnectDBCheck\",\n \"StepName\": \"连接DB检查\",\n \"StepNo\": 1,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"Status\": \"finished\",\n \"StepId\": \"OptimizeCheck\",\n \"StepName\": \"周边检查\",\n \"StepNo\": 2,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"Status\": \"finished\",\n \"StepId\": \"VersionCheck\",\n \"StepName\": \"版本检查\",\n \"StepNo\": 3,\n \"Warnings\": []\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"Status\": \"finished\",\n \"StepId\": \"SrcPrivilegeCheck\",\n \"StepName\": \"源实例权限检查\",\n \"StepNo\": 4,\n \"Warnings\": [\n {\n \"HelpDoc\": \"\",\n \"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\"\n }\n ]\n },\n {\n \"Errors\": [],\n \"Percent\": 100,\n \"Status\": \"finished\",\n \"StepId\": \"BinlogParamCheck\",\n \"StepName\": \"binlog参数检查\",\n \"StepNo\": 5,\n \"Warnings\": []\n }\n ],\n \"SubscribeId\": \"subs-9jyki7hniw\"\n }\n}",
222
+ "title": "查询订阅校验任务结果"
223
+ }
224
+ ],
225
+ "DescribeSubscribeDetail": [
226
+ {
227
+ "document": "",
228
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubscribeDetail\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-0b2up6hk4u\"\n}",
229
+ "output": "{\n \"Response\": {\n \"Region\": \"ap-guangzhou\",\n \"AccessType\": \"cdb\",\n \"AutoRenewFlag\": 0,\n \"Broker\": \"guangzhoutest-kafka-3.cdb-dts.tencentcs.com.cn:32339\",\n \"CreateTime\": \"2023-12-06 14:31:27\",\n \"Endpoints\": [\n {\n \"DatabaseRegion\": \"ap-guangzhou\",\n \"EncryptConn\": \"UnEncrypted\",\n \"InstanceId\": \"cdb-kdxona7h\",\n \"User\": \"root\"\n }\n ],\n \"ExpireTime\": \"0000-00-00 00:00:00\",\n \"InstanceId\": \"cdb-kdxona7h\",\n \"InstanceStatus\": \"running\",\n \"IsolateTime\": \"0000-00-00 00:00:00\",\n \"KafkaConfig\": {\n \"DistributeRules\": [\n {\n \"DbPattern\": \"db1\",\n \"RuleType\": \"cols\",\n \"TablePattern\": \"table1\",\n \"Columns\": [\n \"id\"\n ]\n },\n {\n \"DbPattern\": \".*\",\n \"RuleType\": \"table\",\n \"TablePattern\": \".*\",\n \"Columns\": null\n }\n ],\n \"NumberOfPartitions\": 8\n },\n \"ModifyTime\": \"2023-12-06 14:33:47\",\n \"OfflineTime\": \"0000-00-00 00:00:00\",\n \"PayType\": 0,\n \"Product\": \"mysql\",\n \"Protocol\": \"json\",\n \"Status\": \"normal\",\n \"SubsStatus\": \"running\",\n \"SubscribeId\": \"subs-0b2up6hk4u\",\n \"SubscribeName\": \"test\",\n \"SubscribeMode\": \"all\",\n \"Topic\": \"topic-subs-0b2up6hk4u-cdb-kdxona7h\",\n \"RequestId\": \"7bd11a40-9406-11ee-9689-216abbbe2107\"\n }\n}",
230
+ "title": "查询订阅任务详情"
231
+ }
232
+ ],
233
+ "DescribeSubscribeJobs": [
234
+ {
235
+ "document": "",
236
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubscribeJobs\n<公共请求参数>\n\n{\n \"Offset\": 0,\n \"Limit\": 10\n}",
237
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"SubscribeId\": \"subs-5ft0e2nrc0\",\n \"SubscribeName\": \"name-5ft0e2nrc0\",\n \"Topic\": \"topic-subs-5ft0e2nrc0-cdb-kdxona7h\",\n \"Product\": \"mysql\",\n \"InstanceId\": \"cdb-kdxona7h\",\n \"InstanceStatus\": \"running\",\n \"Status\": \"normal\",\n \"SubsStatus\": \"running\",\n \"ModifyTime\": \"2023-10-01 12:00:00\",\n \"CreateTime\": \"2023-09-01 12:00:00\",\n \"IsolateTime\": \"0000-00-00 00:00:00\",\n \"ExpireTime\": \"2023-11-01 12:00:00\",\n \"OfflineTime\": \"0000-00-00 00:00:00\",\n \"PayType\": 0,\n \"AutoRenewFlag\": 0,\n \"Region\": \"ap-guangzhou\",\n \"AccessType\": \"cdb\",\n \"Endpoints\": [\n {\n \"DatabaseRegion\": \"ap-guangzhou\",\n \"InstanceId\": \"cdb-kdxona7h\",\n \"EncryptConn\": \"Encrypted\",\n \"User\": \"root\"\n }\n ],\n \"SubscribeVersion\": \"kafka\"\n }\n ],\n \"RequestId\": \"cd6eebd0-9405-11ee-9689-216abbbe2107\"\n }\n}",
238
+ "title": "查询订阅任务列表"
239
+ }
240
+ ],
241
+ "DescribeSubscribeReturnable": [
242
+ {
243
+ "document": "查询订阅实例是否可以退换",
244
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubscribeReturnable\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\"\n}",
245
+ "output": "{\n \"Response\": {\n \"IsReturnable\": true,\n \"ReturnFailMessage\": \"\",\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
246
+ "title": "查询订阅实例是否可以退换"
247
+ }
248
+ ],
161
249
  "DescribeSyncJobs": [
162
250
  {
163
251
  "document": "查询同步任务列表",
@@ -166,6 +254,14 @@
166
254
  "title": "查询同步任务列表"
167
255
  }
168
256
  ],
257
+ "DestroyIsolatedSubscribe": [
258
+ {
259
+ "document": "订阅任务已经隔离,立即发起下线任务",
260
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroyIsolatedSubscribe\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\"\n}",
261
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
262
+ "title": "下线已隔离的数据订阅实例"
263
+ }
264
+ ],
169
265
  "DestroyMigrateJob": [
170
266
  {
171
267
  "document": "",
@@ -190,6 +286,14 @@
190
286
  "title": "隔离(销毁)数据迁移任务"
191
287
  }
192
288
  ],
289
+ "IsolateSubscribe": [
290
+ {
291
+ "document": "隔离订阅任务",
292
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: IsolateSubscribe\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\"\n}",
293
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
294
+ "title": "隔离订阅任务"
295
+ }
296
+ ],
193
297
  "IsolateSyncJob": [
194
298
  {
195
299
  "document": "隔离一个正在计费的同步任务",
@@ -214,6 +318,22 @@
214
318
  "title": "修改一致性校验任务名称"
215
319
  }
216
320
  ],
321
+ "ModifyConsumerGroupDescription": [
322
+ {
323
+ "document": "修改消费组备注",
324
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsumerGroupDescription\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"AccountName\": \"account-subs-9jyki7hniw-1\",\n \"ConsumerGroupName\": \"consumer-grp-subs-9jyki7hniw-1\",\n \"Description\": \"this is a test group\"\n}",
325
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bef6a6f0-f3b1-11ed-b987-7301347aa36f\"\n }\n}",
326
+ "title": "修改消费组备注"
327
+ }
328
+ ],
329
+ "ModifyConsumerGroupPassword": [
330
+ {
331
+ "document": "修改消费组密码",
332
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsumerGroupPassword\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"AccountName\": \"account-subs-9jyki7hniw-1\",\n \"ConsumerGroupName\": \"consumer-grp-subs-9jyki7hniw-1\",\n \"OldPassword\": \"123\",\n \"NewPassword\": \"asdiouy09\"\n}",
333
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bef6a6f0-f3b1-11ed-b987-7301347aa36f\"\n }\n}",
334
+ "title": "修改消费组密码"
335
+ }
336
+ ],
217
337
  "ModifyMigrateJobSpec": [
218
338
  {
219
339
  "document": "",
@@ -254,6 +374,30 @@
254
374
  "title": "配置迁移任务"
255
375
  }
256
376
  ],
377
+ "ModifySubscribeAutoRenewFlag": [
378
+ {
379
+ "document": "将一个包年包月的订阅任务从不自动续费改为自动续费",
380
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySubscribeAutoRenewFlag\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"AutoRenewFlag\": 1\n}",
381
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
382
+ "title": "修改数据订阅自动续费标识"
383
+ }
384
+ ],
385
+ "ModifySubscribeName": [
386
+ {
387
+ "document": "修改数据订阅实例的名称",
388
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySubscribeName\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\",\n \"SubscribeName\": \"subscribe-test\"\n}",
389
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
390
+ "title": "修改数据订阅实例的名称"
391
+ }
392
+ ],
393
+ "ModifySubscribeObjects": [
394
+ {
395
+ "document": "修改数据订阅的订阅规则,如添加或者移除某些库表",
396
+ "input": "https://dts.tencentcloudapi.com/?Action=ModifySubscribeObjects\r\n&SubscribeId=subs-ieuwi83j2e\r\n&SubscribeObjectType=0\r\n&<公共请求参数>",
397
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
398
+ "title": "修改数据订阅通道的订阅规则"
399
+ }
400
+ ],
257
401
  "ModifySyncJobConfig": [
258
402
  {
259
403
  "document": "在需要修改对象时、通过该接口开始配置修改对象的任务",
@@ -302,6 +446,22 @@
302
446
  "title": "解除隔离同步任务"
303
447
  }
304
448
  ],
449
+ "ResetConsumerGroupOffset": [
450
+ {
451
+ "document": "将一个订阅任务的kafka offset重置到2023-05-16 00:00:00附近的checkpoint",
452
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetConsumerGroupOffset\n<公共请求参数>\n\n{\n \"ConsumerGroupName\": \"consumer-grp-subs-635ns8r71g-1\",\n \"PartitionNos\": [\n \"0\",\n \"1\",\n \"2\",\n \"3\"\n ],\n \"ResetMode\": \"datetime\",\n \"ResetDatetime\": \"2023-05-16 00:00:00\",\n \"SubscribeId\": \"subs-635ns8r71g\",\n \"TopicName\": \"account-subs-635ns8r71g-1\"\n}",
453
+ "output": "{\n \"Response\": {\n \"RequestId\": \"20461920-b18e-11ec-ae1a-cfe224f4f21f\"\n }\n}",
454
+ "title": "重置消费组offset"
455
+ }
456
+ ],
457
+ "ResetSubscribe": [
458
+ {
459
+ "document": "重置数据订阅任务",
460
+ "input": "https://dts.tencentcloudapi.com/?Action=ResetSubscribe\r\n&SubscribeId=subs-ieuwi83j2e\r\n&<公共请求参数>",
461
+ "output": "{\n \"Response\": {\n \"RequestId\": \"14a719b5-ffb34ab6-816c43c1-8c6a23eb\"\n }\n}",
462
+ "title": "重置数据订阅任务"
463
+ }
464
+ ],
305
465
  "ResizeSyncJob": [
306
466
  {
307
467
  "document": "",
@@ -318,6 +478,14 @@
318
478
  "title": "重试失败的数据迁移任务"
319
479
  }
320
480
  ],
481
+ "ResumeSubscribe": [
482
+ {
483
+ "document": "通过重启尝试恢复一个报错的任务",
484
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResumeSubscribe\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-9jyki7hniw\"\n}",
485
+ "output": "{\n \"Response\": {\n \"RequestId\": \"b048a800-f2fe-11ed-a211-5df19a912eab\"\n }\n}",
486
+ "title": "恢复订阅任务"
487
+ }
488
+ ],
321
489
  "ResumeSyncJob": [
322
490
  {
323
491
  "document": "",
@@ -366,6 +534,14 @@
366
534
  "title": "开始修改对象"
367
535
  }
368
536
  ],
537
+ "StartSubscribe": [
538
+ {
539
+ "document": "开启数据订阅任务",
540
+ "input": "POST / HTTP/1.1\nHost: dts.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartSubscribe\n<公共请求参数>\n\n{\n \"SubscribeId\": \"subs-635ns8r71g\"\n}",
541
+ "output": "{\n \"Response\": {\n \"RequestId\": \"da826d80-f2fa-11ed-9136-c7bfacc9cf90\"\n }\n}",
542
+ "title": "开启数据订阅任务"
543
+ }
544
+ ],
369
545
  "StartSyncJob": [
370
546
  {
371
547
  "document": "",
@@ -4397,7 +4397,7 @@
4397
4397
  },
4398
4398
  {
4399
4399
  "disabled": false,
4400
- "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id</li>\n</ul>",
4400
+ "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id(通过控制台创建模板后获取模板Id)</li>\n</ul>\n注意:需要同时设置 ResourceType 参数指定资源类型",
4401
4401
  "example": "无",
4402
4402
  "member": "string",
4403
4403
  "name": "ResourceId",
@@ -4413,6 +4413,15 @@
4413
4413
  "required": true,
4414
4414
  "type": "string"
4415
4415
  },
4416
+ {
4417
+ "disabled": false,
4418
+ "document": "资源类型,取值有:\n<ul><li> **1**:模板</li>\n<li> **2**:文件(默认值)</li></ul>",
4419
+ "example": "1",
4420
+ "member": "int64",
4421
+ "name": "ResourceType",
4422
+ "required": false,
4423
+ "type": "int"
4424
+ },
4416
4425
  {
4417
4426
  "disabled": false,
4418
4427
  "document": "合同流程的签署顺序类型:\n<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>\n<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>",
@@ -4467,15 +4476,6 @@
4467
4476
  "required": false,
4468
4477
  "type": "string"
4469
4478
  },
4470
- {
4471
- "disabled": false,
4472
- "document": "资源类型,取值有:\n<ul><li> **1**:模板</li>\n<li> **2**:文件(默认值)</li></ul>",
4473
- "example": "1",
4474
- "member": "int64",
4475
- "name": "ResourceType",
4476
- "required": false,
4477
- "type": "int"
4478
- },
4479
4479
  {
4480
4480
  "disabled": false,
4481
4481
  "document": "该字段已废弃,请使用InitiatorComponents",
@@ -6939,7 +6939,7 @@
6939
6939
  },
6940
6940
  {
6941
6941
  "disabled": false,
6942
- "document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0,最大2000。\n分页参数, 需要limit, offset 配合使用\n例如:\n您希望得到第三页的数据, 且每页限制最多10条\n你可以使用 LIMIT 10 OFFSET 20\n",
6942
+ "document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0,最大2000。\n分页参数, 需要limit, offset 配合使用\n例如:\n您希望得到第三页的数据, 且每页限制最多10条\n您可以使用 LIMIT 10 OFFSET 20\n",
6943
6943
  "example": "无",
6944
6944
  "member": "uint64",
6945
6945
  "name": "Offset",
@@ -6954,7 +6954,7 @@
6954
6954
  "members": [
6955
6955
  {
6956
6956
  "disabled": false,
6957
- "document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0, 最大为2000\n分页参数, 需要limit, offset 配合使用\n例如:\n您希望得到第三页的数据, 且每页限制最多10条\n你可以使用 LIMIT 10 OFFSET 20",
6957
+ "document": "OFFSET 用于指定查询结果的偏移量,如果不传默认偏移为0, 最大为2000\n分页参数, 需要limit, offset 配合使用\n例如:\n您希望得到第三页的数据, 且每页限制最多10条\n您可以使用 LIMIT 10 OFFSET 20",
6958
6958
  "example": "1",
6959
6959
  "member": "uint64",
6960
6960
  "name": "Offset",
@@ -316,7 +316,7 @@
316
316
  "status": "online"
317
317
  },
318
318
  "CreateChannelOrganizationInfoChangeUrl": {
319
- "document": "此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接。\n\n<h3 id=\"1\">支持变更链接类型,通过入参 Endpoint 指定,默认为WEIXINAPP。</h3>\n\n<h4 id=\"WEIXINAPP\">WEIXINAPP</h4>\n<p>创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。</p>\n\n<h4 id=\"APP\">APP</h4>\n<p>创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</p>\n\n\n<h3 id=\"2\">支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。</h3>\n\n<h4 id=\"1-企业超管变更\">1. 企业超管变更</h4>\n\n<p>换成企业的其他员工来当超管</p>\n\n<h4 id=\"2-企业基础信息变更\">2. 企业基础信息变更</h4>\n\n<h5 id=\"可以变动\">可以变动</h5>\n\n<ul>\n<li>企业名称<br>\n</li>\n<li>法定代表人姓名(新法人有邀请链接)<br>\n</li>\n<li>企业地址和所在地</li>\n</ul>\n\n<h5 id=\"不可变动\">不可变动</h5>\n\n<ul>\n<li>统一社会信用代码<br>\n</li>\n<li>企业主体类型</li>\n</ul>\n\n<p>如果企业名称变动会引起下面的变动</p>\n\n<ul>\n<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>\n<li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>\n<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>\n</ul>\n\n\n注意: \n1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”\n2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管",
319
+ "document": "此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接。\n\n<h3 id=\"1\">支持变更链接类型,通过入参 Endpoint 指定,默认为WEIXINAPP。</h3>\n\n<h4 id=\"WEIXINAPP\">WEIXINAPP</h4>\n<p>创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。</p>\n\n<h4 id=\"APP\">APP</h4>\n<p>创建变更小程序链接,可从第三方App跳转到微信腾讯电子签小程序进行更换。</p>\n\n\n<h3 id=\"2\">支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。</h3>\n\n<h4 id=\"1-企业超管变更\">1. 企业超管变更</h4>\n\n<p>换成企业的其他员工来当超管</p>\n\n<h4 id=\"2-企业基础信息变更\">2. 企业基础信息变更</h4>\n\n<h5 id=\"可以变动\">可以变动</h5>\n\n<ul>\n<li>企业名称<br>\n</li>\n<li>法定代表人姓名(新法人有邀请链接)<br>\n</li>\n<li>企业地址和所在地</li>\n</ul>\n\n<h5 id=\"不可变动\">不可变动</h5>\n\n<ul>\n<li>统一社会信用代码<br>\n</li>\n<li>企业主体类型</li>\n</ul>\n\n<p>如果企业名称变动会引起下面的变动</p>\n\n<ul>\n<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>\n<li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>\n<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>\n</ul>\n\n\n注意: \n1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”\n2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管",
320
320
  "input": "CreateChannelOrganizationInfoChangeUrlRequest",
321
321
  "name": "获取变更企业信息电子签小程序链接",
322
322
  "output": "CreateChannelOrganizationInfoChangeUrlResponse",
@@ -2986,7 +2986,7 @@
2986
2986
  },
2987
2987
  {
2988
2988
  "disabled": false,
2989
- "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id</li>\n</ul>",
2989
+ "document": "资源id,与ResourceType相对应,取值范围:\n<ul>\n<li>文件Id(通过UploadFiles获取文件资源Id)</li>\n<li>模板Id(通过控制台创建模板后获取模板Id)</li>\n</ul>\n注意:需要同时设置 ResourceType 参数指定资源类型",
2990
2990
  "example": "无",
2991
2991
  "member": "string",
2992
2992
  "name": "ResourceId",
@@ -5782,7 +5782,7 @@
5782
5782
  },
5783
5783
  {
5784
5784
  "disabled": false,
5785
- "document": "变更链接类型:\n<ul>\n<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>\n<li>**APP** : 创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</li>\n</ul>",
5785
+ "document": "变更链接类型:\n<ul>\n<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>\n<li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>\n</ul>",
5786
5786
  "example": "无",
5787
5787
  "member": "string",
5788
5788
  "name": "Endpoint",
@@ -277,7 +277,7 @@
277
277
  "ChannelCreatePrepareFlow": [
278
278
  {
279
279
  "document": "",
280
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\":{\n \"ProxyOperator\":{\n \"OpenId\":\"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\":\"572c69xxxxxx245e4\",\n \"AppId\":\"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\":\"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\":2,\n \"FlowInfo\":{\n \"FlowName\":\"第三方预发起合同-跳过文件上传\",\n \"FlowType\":\"第三方嵌入式文件发起合同\",\n \"FlowDescription\":\"\",\n \"Deadline\":0,\n \"Unordered\":false,\n \"IntelligentStatus\":\"CLOSE\",\n \"FormFields\":[\n\n ],\n \"NeedCreateReview\":false,\n \"NeedSignReview\":false,\n \"UserData\":\"\",\n \"CcInfos\":[\n\n ]\n },\n \"FlowOption\":{\n \"CanEditFlow\":true,\n \"CanEditFormField\":true,\n \"HideShowFlowName\":false,\n \"HideShowFlowType\":false,\n \"HideShowDeadline\":false,\n \"ForbidEditFillComponent\":false,\n \"CustomCreateFlowDescription\":\"\"\n },\n \"FlowApproverList\":[\n {\n \"ApproverType\":0,\n \"NotChannelOrganization\":false,\n \"OrganizationOpenId\":\"org_dianziqian\",\n \"OrganizationName\":\"典子谦示例企业\",\n \"OpenId\":\"n131517\",\n \"ApproverOption\":{\n \"CanEditApprover\":true\n },\n \"IsFullText\":true,\n \"PreReadTime\":0\n },\n {\n \"ApproverType\":1,\n \"ApproverIdCardType\":\"\",\n \"ApproverName\":\"里斯\",\n \"NotChannelOrganization\":false,\n \"ApproverMobile\":\"13312312312\",\n \"IsFullText\":true,\n \"PreReadTime\":0\n }\n ]\n}",
280
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreatePrepareFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"5d18c1c4c8926cd11\"\n },\n \"ProxyOrganizationOpenId\": \"572c69xxxxxx245e4\",\n \"AppId\": \"yDRsbUUgxxxx7ZfBvipOMJ\"\n },\n \"ResourceId\": \"yDwqFUUckp3em41rUwWPgIBjsYgG5bba\",\n \"ResourceType\": 2,\n \"FlowInfo\": {\n \"FlowName\": \"第三方预发起合同-跳过文件上传\",\n \"FlowType\": \"第三方嵌入式文件发起合同\",\n \"FlowDescription\": \"\",\n \"Deadline\": 0,\n \"Unordered\": false,\n \"IntelligentStatus\": \"CLOSE\",\n \"FormFields\": [],\n \"NeedCreateReview\": false,\n \"NeedSignReview\": false,\n \"UserData\": \"\",\n \"CcInfos\": []\n },\n \"FlowOption\": {\n \"CanEditFlow\": true,\n \"HideShowFlowName\": false,\n \"HideShowFlowType\": false,\n \"HideShowDeadline\": false,\n \"ForbidEditFillComponent\": false,\n \"CustomCreateFlowDescription\": \"\"\n },\n \"FlowApproverList\": [\n {\n \"ApproverType\": 0,\n \"NotChannelOrganization\": false,\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"OrganizationName\": \"典子谦示例企业\",\n \"OpenId\": \"n131517\",\n \"ApproverOption\": {\n \"CanEditApprover\": true\n },\n \"IsFullText\": true,\n \"PreReadTime\": 0\n },\n {\n \"ApproverType\": 1,\n \"ApproverIdCardType\": \"\",\n \"ApproverName\": \"里斯\",\n \"NotChannelOrganization\": false,\n \"ApproverMobile\": \"13312312312\",\n \"IsFullText\": true,\n \"PreReadTime\": 0\n }\n ]\n}",
281
281
  "output": "{\n \"Response\": {\n \"PrepareFlowUrl\": \"https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb\",\n \"PreviewFlowUrl\": \"\",\n \"RequestId\": \"c52aaa17-3f81-4640-be03-fca0a553d2e3\"\n }\n}",
282
282
  "title": "文件发起-跳过文件上传"
283
283
  },
@@ -2471,8 +2471,7 @@
2471
2471
  "member": "string",
2472
2472
  "name": "Region",
2473
2473
  "required": true,
2474
- "type": "string",
2475
- "value_allowed_null": false
2474
+ "type": "string"
2476
2475
  },
2477
2476
  {
2478
2477
  "disabled": false,
@@ -2481,8 +2480,7 @@
2481
2480
  "member": "int64",
2482
2481
  "name": "RegionId",
2483
2482
  "required": false,
2484
- "type": "int",
2485
- "value_allowed_null": false
2483
+ "type": "int"
2486
2484
  },
2487
2485
  {
2488
2486
  "disabled": false,
@@ -2491,8 +2489,7 @@
2491
2489
  "member": "string",
2492
2490
  "name": "Dimensions",
2493
2491
  "required": false,
2494
- "type": "string",
2495
- "value_allowed_null": false
2492
+ "type": "string"
2496
2493
  },
2497
2494
  {
2498
2495
  "disabled": false,
@@ -2501,8 +2498,7 @@
2501
2498
  "member": "string",
2502
2499
  "name": "EventDimensions",
2503
2500
  "required": false,
2504
- "type": "string",
2505
- "value_allowed_null": false
2501
+ "type": "string"
2506
2502
  }
2507
2503
  ],
2508
2504
  "usage": "in"
@@ -3628,6 +3624,15 @@
3628
3624
  "name": "TagSpecification",
3629
3625
  "required": false,
3630
3626
  "type": "list"
3627
+ },
3628
+ {
3629
+ "disabled": false,
3630
+ "document": "是否自动选择代金券,默认为 false",
3631
+ "example": "true",
3632
+ "member": "bool",
3633
+ "name": "AutoVoucher",
3634
+ "required": false,
3635
+ "type": "bool"
3631
3636
  }
3632
3637
  ],
3633
3638
  "type": "object"
@@ -19315,7 +19315,7 @@
19315
19315
  "members": [
19316
19316
  {
19317
19317
  "disabled": false,
19318
- "document": "发票类型\n026:增值税电子普通发票\n028:增值税电子专用发票\n010:电子发票(普通发票)\n020:电子发票(增值税专用发票)",
19318
+ "document": "发票类型\n026:增值税电子普通发票\n028:增值税电子专用发票\n010:电子发票(普通发票)\n020:电子发票(增值税专用发票)\n030:电子发票(铁路电子客票)\n040:电子发票(航空运输电子客票行程单)",
19319
19319
  "example": "026",
19320
19320
  "member": "string",
19321
19321
  "name": "Type",
@@ -694,7 +694,7 @@
694
694
  {
695
695
  "document": "ofd发票识别",
696
696
  "input": "https://ocr.tencentcloudapi.com/?Action=VerifyOfdVatInvoiceOCR\n&OfdFileUrl=https://xx/a.jpg\n&<公共请求参数>",
697
- "output": "{\n \"Response\": {\n \"Buyer\": {\n \"AddrTel\": \"北京海淀区西钓鱼台嘉园北门13392342520\",\n \"FinancialAccount\": \"北京农商行32445333322211\",\n \"Name\": \"科游迈利有限公司\",\n \"TaxId\": \"9150010807MGZHI002\"\n },\n \"Checker\": \"张嘉诺\",\n \"GoodsInfos\": [\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n },\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n },\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n }\n ],\n \"InvoiceCheckCode\": \"17803957977493679699\",\n \"InvoiceClerk\": \"任盈盈\",\n \"InvoiceCode\": \"050001700111\",\n \"InvoiceNumber\": \"62346438\",\n \"IssueDate\": \"2020年06月18日\",\n \"MachineNumber\": \"016000015903\",\n \"Note\": \"对应正数发票代码:050001700111号码:62346436\",\n \"Payee\": \"张一诺\",\n \"RequestId\": \"7ea56704-eb43-455a-a608-6d79f5e70b37\",\n \"Seller\": {\n \"AddrTel\": \"北京市海淀区颐和园西路一亩园11号\",\n \"FinancialAccount\": \"建设银行625555888900998711\",\n \"Name\": \"深圳高灯云科技有限公司\",\n \"TaxId\": \"91500300MA5FNDGU8Y\"\n },\n \"TaxControlCode\": \"002280/993-4692+</-0-5-57+1-61>739+2/07>*5++3-30>+2154-80/*576>3/411+3/3>->*/--++6875624-<41<0>*0<11*/2-1922<7>4\",\n \"TaxExclusiveTotalAmount\": \"-300.00\",\n \"TaxInclusiveTotalAmount\": \"-318.00\",\n \"TaxTotalAmount\": \"-18.00\",\n \"Type\": \"026\",\n \"AirTicketInfo\": {\n \"PassengerName\": \"abc\",\n \"ValidIdNumber\": \"abc\",\n \"Endorsement\": \"abc\",\n \"ElectronicInvoiceAirTransportReceiptNumber\": \"abc\",\n \"DetailInformationOfAirTicketTuple\": [\n {\n \"DepartureStation\": \"abc\",\n \"DestinationStation\": \"abc\",\n \"FlightSegment\": \"abc\",\n \"Carrier\": \"abc\",\n \"Flight\": \"abc\",\n \"CarrierDate\": \"abc\",\n \"DepartureTime\": \"abc\",\n \"FareBasis\": \"abc\",\n \"EffectiveDate\": \"abc\",\n \"ExpirationDate\": \"abc\",\n \"FreeBaggageAllowance\": \"abc\"\n }\n ],\n \"Fare\": \"abc\",\n \"FuelSurcharge\": \"abc\",\n \"VatRate\": \"abc\",\n \"VatTaxAmount\": \"abc\",\n \"CivilAviationDevelopmentFund\": \"abc\",\n \"OtherTaxes\": \"abc\",\n \"TotalAmount\": \"abc\",\n \"VerificationCode\": \"abc\",\n \"PromptInformation\": \"abc\",\n \"Insurance\": \"abc\",\n \"AgentCode\": \"abc\",\n \"IssueParty\": \"abc\",\n \"IssueDate\": \"abc\",\n \"IssuingStatus\": \"abc\",\n \"MarkingOfDomesticOrInternational\": \"abc\",\n \"NameOfPurchaser\": \"abc\",\n \"NameOfSeller\": \"abc\",\n \"UnifiedSocialCreditCodeOfPurchaser\": \"abc\"\n },\n \"RailwayTicketInfo\": {\n \"TypeOfVoucher\": \"abc\",\n \"DateOfIssue\": \"abc\",\n \"TypeOfBusiness\": \"abc\",\n \"DepartureStation\": \"abc\",\n \"PhonicsOfDepartureStation\": \"abc\",\n \"DestinationStation\": \"abc\",\n \"PhonicsOfDestinationStation\": \"abc\",\n \"TrainNumber\": \"abc\",\n \"TravelDate\": \"abc\",\n \"DepartureTime\": \"abc\",\n \"AirConditioningCharacteristics\": \"abc\",\n \"SeatLevel\": \"abc\",\n \"Carriage\": \"abc\",\n \"Seat\": \"abc\",\n \"Fare\": \"abc\",\n \"ElectronicInvoiceRailwayETicketNumber\": \"abc\",\n \"IdNumber\": \"abc\",\n \"Name\": \"abc\",\n \"TotalAmountExcludingTax\": \"abc\",\n \"TaxRate\": \"abc\",\n \"TaxAmount\": \"abc\",\n \"NameOfPurchaser\": \"abc\",\n \"UnifiedSocialCreditCodeOfPurchaser\": \"abc\"\n }\n }\n}",
697
+ "output": "{\n \"Response\": {\n \"Buyer\": {\n \"AddrTel\": \"北京海淀区西钓鱼台嘉园北门13392342520\",\n \"FinancialAccount\": \"北京农商行32445333322211\",\n \"Name\": \"科游迈利有限公司\",\n \"TaxId\": \"9150010807MGZHI002\"\n },\n \"Checker\": \"张嘉诺\",\n \"GoodsInfos\": [\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n },\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n },\n {\n \"Amount\": \"-100.00\",\n \"Item\": \"*餐饮服务*餐费\",\n \"MeasurementDimension\": \"次\",\n \"Price\": \"25\",\n \"Quantity\": \"-4\",\n \"Specification\": \"\",\n \"TaxAmount\": \"-6.00\",\n \"TaxScheme\": \"6%\"\n }\n ],\n \"InvoiceCheckCode\": \"17803957977493679699\",\n \"InvoiceClerk\": \"任盈盈\",\n \"InvoiceCode\": \"050001700111\",\n \"InvoiceNumber\": \"62346438\",\n \"IssueDate\": \"2020年06月18日\",\n \"MachineNumber\": \"016000015903\",\n \"Note\": \"对应正数发票代码:050001700111号码:62346436\",\n \"Payee\": \"张一诺\",\n \"RequestId\": \"7ea56704-eb43-455a-a608-6d79f5e70b37\",\n \"Seller\": {\n \"AddrTel\": \"北京市海淀区颐和园西路一亩园11号\",\n \"FinancialAccount\": \"建设银行625555888900998711\",\n \"Name\": \"深圳高灯云科技有限公司\",\n \"TaxId\": \"91500300MA5FNDGU8Y\"\n },\n \"TaxControlCode\": \"002280/993-4692+</-0-5-57+1-61>739+2/07>*5++3-30>+2154-80/*576>3/411+3/3>->*/--++6875624-<41<0>*0<11*/2-1922<7>4\",\n \"TaxExclusiveTotalAmount\": \"-300.00\",\n \"TaxInclusiveTotalAmount\": \"-318.00\",\n \"TaxTotalAmount\": \"-18.00\",\n \"Type\": \"026\",\n \"AirTicketInfo\": {\n \"PassengerName\": \"abc\",\n \"ValidIdNumber\": \"abc\",\n \"Endorsement\": \"abc\",\n \"NumberOfGPOrder\": \"abc\",\n \"ElectronicInvoiceAirTransportReceiptNumber\": \"abc\",\n \"DetailInformationOfAirTicketTuple\": [\n {\n \"DepartureStation\": \"abc\",\n \"DestinationStation\": \"abc\",\n \"FlightSegment\": \"abc\",\n \"Carrier\": \"abc\",\n \"Flight\": \"abc\",\n \"SeatClass\": \"abc\",\n \"CarrierDate\": \"abc\",\n \"DepartureTime\": \"abc\",\n \"FareBasis\": \"abc\",\n \"EffectiveDate\": \"abc\",\n \"ExpirationDate\": \"abc\",\n \"FreeBaggageAllowance\": \"abc\"\n }\n ],\n \"Fare\": \"abc\",\n \"FuelSurcharge\": \"abc\",\n \"VatRate\": \"abc\",\n \"VatTaxAmount\": \"abc\",\n \"CivilAviationDevelopmentFund\": \"abc\",\n \"OtherTaxes\": \"abc\",\n \"TotalAmount\": \"abc\",\n \"ElectronicTicketNum\": \"abc\",\n \"VerificationCode\": \"abc\",\n \"PromptInformation\": \"abc\",\n \"Insurance\": \"abc\",\n \"AgentCode\": \"abc\",\n \"IssueParty\": \"abc\",\n \"IssueDate\": \"abc\",\n \"IssuingStatus\": \"abc\",\n \"MarkingOfDomesticOrInternational\": \"abc\",\n \"NameOfPurchaser\": \"abc\",\n \"NameOfSeller\": \"abc\",\n \"UnifiedSocialCreditCodeOfPurchaser\": \"abc\"\n },\n \"RailwayTicketInfo\": {\n \"TypeOfVoucher\": \"abc\",\n \"ElectronicTicketNum\": \"abc\",\n \"DateOfIssue\": \"abc\",\n \"TypeOfBusiness\": \"abc\",\n \"DepartureStation\": \"abc\",\n \"PhonicsOfDepartureStation\": \"abc\",\n \"DestinationStation\": \"abc\",\n \"PhonicsOfDestinationStation\": \"abc\",\n \"TrainNumber\": \"abc\",\n \"TravelDate\": \"abc\",\n \"DepartureTime\": \"abc\",\n \"AirConditioningCharacteristics\": \"abc\",\n \"SeatLevel\": \"abc\",\n \"Carriage\": \"abc\",\n \"Seat\": \"abc\",\n \"Fare\": \"abc\",\n \"ElectronicInvoiceRailwayETicketNumber\": \"abc\",\n \"IdNumber\": \"abc\",\n \"Name\": \"abc\",\n \"TotalAmountExcludingTax\": \"abc\",\n \"TaxRate\": \"abc\",\n \"TaxAmount\": \"abc\",\n \"NameOfPurchaser\": \"abc\",\n \"UnifiedSocialCreditCodeOfPurchaser\": \"abc\",\n \"NumberOfOriginalInvoice\": \"abc\"\n }\n }\n}",
698
698
  "title": "OFD发票识别示例代码"
699
699
  }
700
700
  ],