tccli 3.0.1095.1__py2.py3-none-any.whl → 3.0.1096.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 (45) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cls/v20201016/DeleteKafkaRecharge.md +3 -3
  3. tccli/examples/cls/v20201016/ModifyKafkaRecharge.md +23 -13
  4. tccli/examples/cls/v20201016/PreviewKafkaRecharge.md +47 -15
  5. tccli/examples/cynosdb/v20190107/AddClusterSlaveZone.md +2 -1
  6. tccli/examples/cynosdb/v20190107/DescribeClusterDetail.md +9 -2
  7. tccli/examples/cynosdb/v20190107/DescribeTasks.md +12 -0
  8. tccli/examples/cynosdb/v20190107/ModifyClusterSlaveZone.md +2 -1
  9. tccli/examples/mps/v20190612/CreateAdaptiveDynamicStreamingTemplate.md +1 -1
  10. tccli/examples/mps/v20190612/ModifyAdaptiveDynamicStreamingTemplate.md +1 -1
  11. tccli/examples/organization/v20210331/DescribeEffectivePolicy.md +25 -0
  12. tccli/examples/organization/v20210331/ListNonCompliantResource.md +43 -0
  13. tccli/examples/ssl/v20191205/DescribeDeleteCertificatesTaskResult.md +72 -0
  14. tccli/examples/trocket/v20230308/DescribeMQTTClient.md +57 -49
  15. tccli/examples/trocket/v20230308/DescribeMQTTInsPublicEndpoints.md +38 -6
  16. tccli/examples/trocket/v20230308/DescribeMQTTInsVPCEndpoints.md +14 -12
  17. tccli/examples/trocket/v20230308/DescribeMQTTInstanceList.md +1 -121
  18. tccli/examples/trocket/v20230308/DescribeMQTTProductSKUList.md +0 -47
  19. tccli/examples/trocket/v20230308/DescribeMQTTUserList.md +1 -1
  20. tccli/services/aiart/v20221229/api.json +1 -1
  21. tccli/services/cls/v20201016/api.json +49 -49
  22. tccli/services/cls/v20201016/examples.json +13 -7
  23. tccli/services/cynosdb/v20190107/api.json +74 -0
  24. tccli/services/cynosdb/v20190107/examples.json +4 -4
  25. tccli/services/essbasic/v20210526/api.json +9 -0
  26. tccli/services/faceid/v20180301/api.json +22 -3
  27. tccli/services/live/v20180801/api.json +9 -0
  28. tccli/services/mps/v20190612/api.json +172 -92
  29. tccli/services/mps/v20190612/examples.json +2 -2
  30. tccli/services/omics/v20221128/api.json +20 -2
  31. tccli/services/organization/organization_client.py +106 -0
  32. tccli/services/organization/v20210331/api.json +258 -0
  33. tccli/services/organization/v20210331/examples.json +16 -0
  34. tccli/services/ssl/ssl_client.py +53 -0
  35. tccli/services/ssl/v20191205/api.json +110 -0
  36. tccli/services/ssl/v20191205/examples.json +8 -0
  37. tccli/services/ssm/v20190923/api.json +1 -1
  38. tccli/services/tdmq/v20200217/api.json +1 -1
  39. tccli/services/trocket/v20230308/api.json +226 -108
  40. tccli/services/trocket/v20230308/examples.json +13 -25
  41. {tccli-3.0.1095.1.dist-info → tccli-3.0.1096.1.dist-info}/METADATA +2 -2
  42. {tccli-3.0.1095.1.dist-info → tccli-3.0.1096.1.dist-info}/RECORD +45 -42
  43. {tccli-3.0.1095.1.dist-info → tccli-3.0.1096.1.dist-info}/WHEEL +0 -0
  44. {tccli-3.0.1095.1.dist-info → tccli-3.0.1096.1.dist-info}/entry_points.txt +0 -0
  45. {tccli-3.0.1095.1.dist-info → tccli-3.0.1096.1.dist-info}/license_files/LICENSE +0 -0
@@ -21,7 +21,7 @@ Output:
21
21
  "ClientNumLimit": 1,
22
22
  "CreateTime": 1705565760,
23
23
  "InstanceId": "mqtt-wjgxr8jg",
24
- "InstanceName": "sunjianxiong-0118-no-pub",
24
+ "InstanceName": "su-0118-no-pub",
25
25
  "InstanceStatus": "CREATE_FAILURE",
26
26
  "InstanceType": "BASIC",
27
27
  "Remark": "",
@@ -32,81 +32,6 @@ Output:
32
32
  "TpsLimit": 1,
33
33
  "Version": "1"
34
34
  },
35
- {
36
- "ClientNumLimit": 1000,
37
- "CreateTime": 1705562417,
38
- "InstanceId": "mqtt-7pnqmkrx",
39
- "InstanceName": "sunjianxiong-1",
40
- "InstanceStatus": "RUNNING",
41
- "InstanceType": "BASIC",
42
- "Remark": "this is remark",
43
- "SkuCode": "basic_1k",
44
- "SubscriptionNumLimit": 1000,
45
- "TopicNum": 0,
46
- "TopicNumLimit": 25,
47
- "TpsLimit": 1000,
48
- "Version": "1"
49
- },
50
- {
51
- "ClientNumLimit": 1000,
52
- "CreateTime": 1705562390,
53
- "InstanceId": "mqtt-92vrwg7q",
54
- "InstanceName": "sunjianxiong-1",
55
- "InstanceStatus": "RUNNING",
56
- "InstanceType": "BASIC",
57
- "Remark": "this is remark",
58
- "SkuCode": "basic_1k",
59
- "SubscriptionNumLimit": 1000,
60
- "TopicNum": 0,
61
- "TopicNumLimit": 25,
62
- "TpsLimit": 1000,
63
- "Version": "1"
64
- },
65
- {
66
- "ClientNumLimit": 1000,
67
- "CreateTime": 1705562343,
68
- "InstanceId": "mqtt-mzjj8pwq",
69
- "InstanceName": "sunjianxiong-1",
70
- "InstanceStatus": "RUNNING",
71
- "InstanceType": "BASIC",
72
- "Remark": "this is remark",
73
- "SkuCode": "basic_1k",
74
- "SubscriptionNumLimit": 1000,
75
- "TopicNum": 0,
76
- "TopicNumLimit": 25,
77
- "TpsLimit": 1000,
78
- "Version": "1"
79
- },
80
- {
81
- "ClientNumLimit": 1000,
82
- "CreateTime": 1705562309,
83
- "InstanceId": "mqtt-r8wq2qbr",
84
- "InstanceName": "sunjianxiong",
85
- "InstanceStatus": "RUNNING",
86
- "InstanceType": "BASIC",
87
- "Remark": "this is remark",
88
- "SkuCode": "basic_1k",
89
- "SubscriptionNumLimit": 1000,
90
- "TopicNum": 0,
91
- "TopicNumLimit": 25,
92
- "TpsLimit": 1000,
93
- "Version": "1"
94
- },
95
- {
96
- "ClientNumLimit": 1000,
97
- "CreateTime": 1705481574,
98
- "InstanceId": "mqtt-o98e9db4",
99
- "InstanceName": "sunjianxiong-0117",
100
- "InstanceStatus": "RUNNING",
101
- "InstanceType": "BASIC",
102
- "Remark": "",
103
- "SkuCode": "basic_1k",
104
- "SubscriptionNumLimit": 1000,
105
- "TopicNum": 1,
106
- "TopicNumLimit": 25,
107
- "TpsLimit": 1000,
108
- "Version": "1"
109
- },
110
35
  {
111
36
  "ClientNumLimit": 1000,
112
37
  "CreateTime": 1705391046,
@@ -121,51 +46,6 @@ Output:
121
46
  "TopicNumLimit": 25,
122
47
  "TpsLimit": 1000,
123
48
  "Version": "1"
124
- },
125
- {
126
- "ClientNumLimit": 1000,
127
- "CreateTime": 1705386756,
128
- "InstanceId": "mqtt-3jaepn74",
129
- "InstanceName": "sunjianxiong",
130
- "InstanceStatus": "RUNNING",
131
- "InstanceType": "BASIC",
132
- "Remark": "this is remark",
133
- "SkuCode": "basic_1k",
134
- "SubscriptionNumLimit": 1000,
135
- "TopicNum": 0,
136
- "TopicNumLimit": 25,
137
- "TpsLimit": 1000,
138
- "Version": "1"
139
- },
140
- {
141
- "ClientNumLimit": 1000,
142
- "CreateTime": 1705305132,
143
- "InstanceId": "mqtt-x4r9v2xq",
144
- "InstanceName": "sunjianxiong-0115",
145
- "InstanceStatus": "RUNNING",
146
- "InstanceType": "BASIC",
147
- "Remark": "",
148
- "SkuCode": "basic_1k",
149
- "SubscriptionNumLimit": 1000,
150
- "TopicNum": 1,
151
- "TopicNumLimit": 25,
152
- "TpsLimit": 1000,
153
- "Version": "1"
154
- },
155
- {
156
- "ClientNumLimit": 1000,
157
- "CreateTime": 1704962679,
158
- "InstanceId": "mqtt-o47zowaz",
159
- "InstanceName": "sjx-0111",
160
- "InstanceStatus": "RUNNING",
161
- "InstanceType": "BASIC",
162
- "Remark": "",
163
- "SkuCode": "basic_1k",
164
- "SubscriptionNumLimit": 1000,
165
- "TopicNum": 0,
166
- "TopicNumLimit": 1000,
167
- "TpsLimit": 1000,
168
- "Version": "1"
169
49
  }
170
50
  ],
171
51
  "RequestId": "9424369d-904f-4fa2-b407-0bd5e536e989",
@@ -7,53 +7,6 @@ Input:
7
7
  ```
8
8
  tccli trocket DescribeMQTTProductSKUList --cli-unfold-argument ```
9
9
 
10
- Output:
11
- ```
12
- {
13
- "Error": null,
14
- "RequestId": null,
15
- "Response": {
16
- "MQTTProductSkuList": [
17
- {
18
- "ClientNumLimit": 1,
19
- "InstanceType": "BASIC",
20
- "OnSale": true,
21
- "ProxySpecCore": 2,
22
- "ProxySpecCount": 1,
23
- "ProxySpecMemory": 4,
24
- "SkuCode": "mqtt_1k",
25
- "SubscriptionNumLimit": 1,
26
- "TopicNumLimit": 1,
27
- "TpsLimit": 1
28
- },
29
- {
30
- "ClientNumLimit": 1000,
31
- "InstanceType": "BASIC",
32
- "OnSale": true,
33
- "ProxySpecCore": 1,
34
- "ProxySpecCount": 2,
35
- "ProxySpecMemory": 2,
36
- "SkuCode": "basic_1k",
37
- "SubscriptionNumLimit": 1000,
38
- "TopicNumLimit": 25,
39
- "TpsLimit": 1000
40
- }
41
- ],
42
- "RequestId": "73a1275e-26ce-494c-90d0-d7f9d0510730",
43
- "TotalCount": 2
44
- }
45
- }
46
- ```
47
-
48
- **Example 2: 标志示例**
49
-
50
- 标志示例
51
-
52
- Input:
53
-
54
- ```
55
- tccli trocket DescribeMQTTProductSKUList --cli-unfold-argument ```
56
-
57
10
  Output:
58
11
  ```
59
12
  {
@@ -25,7 +25,7 @@ Output:
25
25
  "PermRead": true,
26
26
  "PermWrite": true,
27
27
  "Remark": "",
28
- "Username": "sunjianxiong"
28
+ "Username": "user1"
29
29
  }
30
30
  ],
31
31
  "RequestId": "8e86117c-a56c-4598-9e1f-4a039eed6e3a",
@@ -22,7 +22,7 @@
22
22
  "status": "online"
23
23
  },
24
24
  "TextToImage": {
25
- "document": "智能文生图接口提供基础版文生图能力,将根据输入的文本描述,智能生成与之相关的结果图。\n\n智能文生图默认提供3个并发任务数,代表最多能同时处理3个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。",
25
+ "document": "智能文生图接口基于文生图(标准版)模型,将根据输入的文本描述,智能生成与之相关的结果图。\n\n智能文生图默认提供3个并发任务数,代表最多能同时处理3个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。",
26
26
  "input": "TextToImageRequest",
27
27
  "name": "智能文生图",
28
28
  "output": "TextToImageResponse",
@@ -1695,7 +1695,7 @@
1695
1695
  "members": [
1696
1696
  {
1697
1697
  "disabled": false,
1698
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
1698
+ "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
1699
1699
  "example": "0",
1700
1700
  "member": "uint64",
1701
1701
  "name": "KafkaType",
@@ -1722,7 +1722,7 @@
1722
1722
  },
1723
1723
  {
1724
1724
  "disabled": false,
1725
- "document": "ServerAddr是否为加密连接",
1725
+ "document": "ServerAddr是否为加密连接,默认值false。当KafkaType为1用户自建kafka时生效。",
1726
1726
  "example": "true",
1727
1727
  "member": "bool",
1728
1728
  "name": "IsEncryptionAddr",
@@ -1731,7 +1731,7 @@
1731
1731
  },
1732
1732
  {
1733
1733
  "disabled": false,
1734
- "document": "加密访问协议。IsEncryptionAddr参数为true时必填",
1734
+ "document": "加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。",
1735
1735
  "example": "无",
1736
1736
  "member": "KafkaProtocolInfo",
1737
1737
  "name": "Protocol",
@@ -4023,8 +4023,8 @@
4023
4023
  },
4024
4024
  {
4025
4025
  "disabled": false,
4026
- "document": "腾讯云CKafka实例ID,KafkaType为0时必填",
4027
- "example": "",
4026
+ "document": "腾讯云CKafka实例ID,KafkaType为0时必填。",
4027
+ "example": "ckafka-2vrgxbxa",
4028
4028
  "member": "string",
4029
4029
  "name": "KafkaInstance",
4030
4030
  "required": false,
@@ -4032,7 +4032,7 @@
4032
4032
  },
4033
4033
  {
4034
4034
  "disabled": false,
4035
- "document": "服务地址,KafkaType为1时必填",
4035
+ "document": "服务地址,KafkaType为1时必填。",
4036
4036
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
4037
4037
  "member": "string",
4038
4038
  "name": "ServerAddr",
@@ -4041,7 +4041,7 @@
4041
4041
  },
4042
4042
  {
4043
4043
  "disabled": false,
4044
- "document": "ServerAddr是否为加密连接,KafkaType为1时必填",
4044
+ "document": "ServerAddr是否为加密连接,KafkaType为1时必填。",
4045
4045
  "example": "true",
4046
4046
  "member": "bool",
4047
4047
  "name": "IsEncryptionAddr",
@@ -4050,7 +4050,7 @@
4050
4050
  },
4051
4051
  {
4052
4052
  "disabled": false,
4053
- "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填",
4053
+ "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填。",
4054
4054
  "example": "无",
4055
4055
  "member": "KafkaProtocolInfo",
4056
4056
  "name": "Protocol",
@@ -4075,7 +4075,7 @@
4075
4075
  {
4076
4076
  "disabled": false,
4077
4077
  "document": "Kafka导入配置ID",
4078
- "example": "xxx-xxx-xxx",
4078
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
4079
4079
  "member": "string",
4080
4080
  "name": "Id",
4081
4081
  "output_required": true,
@@ -4413,8 +4413,8 @@
4413
4413
  },
4414
4414
  {
4415
4415
  "disabled": false,
4416
- "document": "创建的投递规则投递的bucket",
4417
- "example": "bucketName-appid",
4416
+ "document": "COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。",
4417
+ "example": "examplebucket-1250000000",
4418
4418
  "member": "string",
4419
4419
  "name": "Bucket",
4420
4420
  "required": true,
@@ -4422,8 +4422,8 @@
4422
4422
  },
4423
4423
  {
4424
4424
  "disabled": false,
4425
- "document": "创建的投递规则投递目录的前缀",
4426
- "example": "",
4425
+ "document": "投递规则投递的新的目录前缀。\n- 仅支持0-9A-Za-z-_/\n- 最大支持256个字符",
4426
+ "example": "var/xxx",
4427
4427
  "member": "string",
4428
4428
  "name": "Prefix",
4429
4429
  "required": true,
@@ -4441,7 +4441,7 @@
4441
4441
  {
4442
4442
  "disabled": false,
4443
4443
  "document": "投递的时间间隔,单位 秒,默认300,范围 300-900",
4444
- "example": "60",
4444
+ "example": "300",
4445
4445
  "member": "uint64",
4446
4446
  "name": "Interval",
4447
4447
  "required": false,
@@ -4503,8 +4503,8 @@
4503
4503
  },
4504
4504
  {
4505
4505
  "disabled": false,
4506
- "document": "投递数据范围的开始时间点,不能超出日志主题的生命周期起点。如果用户不填写,默认为用户新建投递任务的时间。",
4507
- "example": "0",
4506
+ "document": "投递数据范围的开始时间点(秒级时间戳),不能超出日志主题的生命周期起点。\n如果用户不填写,默认为用户新建投递任务的时间。",
4507
+ "example": "1713410880",
4508
4508
  "member": "int64",
4509
4509
  "name": "StartTime",
4510
4510
  "required": false,
@@ -4512,8 +4512,8 @@
4512
4512
  },
4513
4513
  {
4514
4514
  "disabled": false,
4515
- "document": "投递数据范围的结束时间点,不能填写未来时间。如果用户不填写,默认为持续投递,即无限。",
4516
- "example": "0",
4515
+ "document": "投递数据范围的结束时间点(秒级时间戳),不能填写未来时间。\n如果用户不填写,默认为持续投递,即无限。",
4516
+ "example": "1713497280",
4517
4517
  "member": "int64",
4518
4518
  "name": "EndTime",
4519
4519
  "required": false,
@@ -4521,7 +4521,7 @@
4521
4521
  },
4522
4522
  {
4523
4523
  "disabled": false,
4524
- "document": "cos桶存储类型",
4524
+ "document": "cos桶存储类型。支持:STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。\n\n1. STANDARD_IA:低频存储;\n2. ARCHIVE:归档存储;\n3. DEEP_ARCHIVE:深度归档存储;\n4. STANDARD:标准存储;\n5. MAZ_STANDARD:标准存储(多 AZ);\n6. MAZ_STANDARD_IA:低频存储(多 AZ);\n7. INTELLIGENT_TIERING:智能分层存储。",
4525
4525
  "example": "STANDARD",
4526
4526
  "member": "string",
4527
4527
  "name": "StorageType",
@@ -5334,7 +5334,7 @@
5334
5334
  {
5335
5335
  "disabled": false,
5336
5336
  "document": "Kafka导入配置ID",
5337
- "example": "",
5337
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895",
5338
5338
  "member": "string",
5339
5339
  "name": "Id",
5340
5340
  "required": true,
@@ -5343,7 +5343,7 @@
5343
5343
  {
5344
5344
  "disabled": false,
5345
5345
  "document": "导入CLS目标topic ID",
5346
- "example": "",
5346
+ "example": "1014cc79-f006-48e4-8820-1dc727054111",
5347
5347
  "member": "string",
5348
5348
  "name": "TopicId",
5349
5349
  "required": true,
@@ -10334,7 +10334,7 @@
10334
10334
  {
10335
10335
  "disabled": false,
10336
10336
  "document": "Kafka导入配置ID",
10337
- "example": "",
10337
+ "example": "1014cc79-f006-48e4-8820-1dc7270540c0",
10338
10338
  "member": "string",
10339
10339
  "name": "Id",
10340
10340
  "required": true,
@@ -10343,7 +10343,7 @@
10343
10343
  {
10344
10344
  "disabled": false,
10345
10345
  "document": "导入CLS目标topic ID",
10346
- "example": "",
10346
+ "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
10347
10347
  "member": "string",
10348
10348
  "name": "TopicId",
10349
10349
  "required": true,
@@ -10360,7 +10360,7 @@
10360
10360
  },
10361
10361
  {
10362
10362
  "disabled": false,
10363
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
10363
+ "document": "导入Kafka类型,0:腾讯云CKafka1:用户自建Kafka",
10364
10364
  "example": "0",
10365
10365
  "member": "uint64",
10366
10366
  "name": "KafkaType",
@@ -10369,8 +10369,8 @@
10369
10369
  },
10370
10370
  {
10371
10371
  "disabled": false,
10372
- "document": "腾讯云CKafka实例ID,KafkaType为0时必填",
10373
- "example": "",
10372
+ "document": "腾讯云CKafka实例ID,KafkaType为0时必填。",
10373
+ "example": "ckafka-2vrgxbxa",
10374
10374
  "member": "string",
10375
10375
  "name": "KafkaInstance",
10376
10376
  "required": false,
@@ -10378,7 +10378,7 @@
10378
10378
  },
10379
10379
  {
10380
10380
  "disabled": false,
10381
- "document": "服务地址",
10381
+ "document": "服务地址,KafkaType为1时必填。",
10382
10382
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
10383
10383
  "member": "string",
10384
10384
  "name": "ServerAddr",
@@ -10387,7 +10387,7 @@
10387
10387
  },
10388
10388
  {
10389
10389
  "disabled": false,
10390
- "document": "ServerAddr是否为加密连接",
10390
+ "document": "ServerAddr是否为加密连接,KafkaType为1时必填。",
10391
10391
  "example": "true",
10392
10392
  "member": "bool",
10393
10393
  "name": "IsEncryptionAddr",
@@ -10396,7 +10396,7 @@
10396
10396
  },
10397
10397
  {
10398
10398
  "disabled": false,
10399
- "document": "加密访问协议,IsEncryptionAddr参数为true时必填",
10399
+ "document": "加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。",
10400
10400
  "example": "无",
10401
10401
  "member": "KafkaProtocolInfo",
10402
10402
  "name": "Protocol",
@@ -10406,7 +10406,7 @@
10406
10406
  {
10407
10407
  "disabled": false,
10408
10408
  "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开",
10409
- "example": "topic1,topic2",
10409
+ "example": "topic-subs-0px4qkvu32-cdb-5zi7jf11",
10410
10410
  "member": "string",
10411
10411
  "name": "UserKafkaTopics",
10412
10412
  "required": false,
@@ -10432,8 +10432,8 @@
10432
10432
  },
10433
10433
  {
10434
10434
  "disabled": false,
10435
- "document": "导入控制,1:暂停,2:继续",
10436
- "example": "",
10435
+ "document": "导入控制,1:暂停;2:继续。",
10436
+ "example": "1",
10437
10437
  "member": "uint64",
10438
10438
  "name": "StatusControl",
10439
10439
  "required": false,
@@ -10738,8 +10738,8 @@
10738
10738
  },
10739
10739
  {
10740
10740
  "disabled": false,
10741
- "document": "投递规则投递的新的bucket",
10742
- "example": "bucketName-appid",
10741
+ "document": "COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。",
10742
+ "example": "examplebucket-1250000000",
10743
10743
  "member": "string",
10744
10744
  "name": "Bucket",
10745
10745
  "required": false,
@@ -10747,8 +10747,8 @@
10747
10747
  },
10748
10748
  {
10749
10749
  "disabled": false,
10750
- "document": "投递规则投递的新的目录前缀",
10751
- "example": "",
10750
+ "document": "投递规则投递的新的目录前缀。\n- 仅支持0-9A-Za-z-_/\n- 最大支持256个字符",
10751
+ "example": "var/xxx",
10752
10752
  "member": "string",
10753
10753
  "name": "Prefix",
10754
10754
  "required": false,
@@ -10756,7 +10756,7 @@
10756
10756
  },
10757
10757
  {
10758
10758
  "disabled": false,
10759
- "document": "投递规则的开关状态",
10759
+ "document": "投递规则的开关状态。true:开启投递任务;false:关闭投递任务。",
10760
10760
  "example": "true",
10761
10761
  "member": "bool",
10762
10762
  "name": "Status",
@@ -10828,7 +10828,7 @@
10828
10828
  },
10829
10829
  {
10830
10830
  "disabled": false,
10831
- "document": "投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名)",
10831
+ "document": "投递文件命名配置,0:随机数命名,1:投递时间命名。",
10832
10832
  "example": "0",
10833
10833
  "member": "uint64",
10834
10834
  "name": "FilenameMode",
@@ -10837,7 +10837,7 @@
10837
10837
  },
10838
10838
  {
10839
10839
  "disabled": false,
10840
- "document": "cos桶类型",
10840
+ "document": "cos桶存储类型。支持:STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。\n\n1. STANDARD_IA:低频存储;\n2. ARCHIVE:归档存储;\n3. DEEP_ARCHIVE:深度归档存储;\n4. STANDARD:标准存储;\n5. MAZ_STANDARD:标准存储(多 AZ);\n6. MAZ_STANDARD_IA:低频存储(多 AZ);\n7. INTELLIGENT_TIERING:智能分层存储。",
10841
10841
  "example": "STANDARD",
10842
10842
  "member": "string",
10843
10843
  "name": "StorageType",
@@ -11336,7 +11336,7 @@
11336
11336
  "members": [
11337
11337
  {
11338
11338
  "disabled": false,
11339
- "document": "预览类型,1:源数据预览,2:导出结果预览",
11339
+ "document": "预览类型,1:源数据预览;2:导出结果预览。",
11340
11340
  "example": "1",
11341
11341
  "member": "uint64",
11342
11342
  "name": "PreviewType",
@@ -11345,8 +11345,8 @@
11345
11345
  },
11346
11346
  {
11347
11347
  "disabled": false,
11348
- "document": "导入Kafka类型,0: 腾讯云CKafka1: 用户自建Kafka",
11349
- "example": "",
11348
+ "document": "导入Kafka类型,0:腾讯云CKafka1:用户自建Kafka",
11349
+ "example": "1",
11350
11350
  "member": "uint64",
11351
11351
  "name": "KafkaType",
11352
11352
  "required": true,
@@ -11354,8 +11354,8 @@
11354
11354
  },
11355
11355
  {
11356
11356
  "disabled": false,
11357
- "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。最多支持100个。",
11358
- "example": "topic1,topic2",
11357
+ "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。\n最多支持100个。",
11358
+ "example": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111",
11359
11359
  "member": "string",
11360
11360
  "name": "UserKafkaTopics",
11361
11361
  "required": true,
@@ -11363,7 +11363,7 @@
11363
11363
  },
11364
11364
  {
11365
11365
  "disabled": false,
11366
- "document": "导入数据位置,-2:最早(默认),-1:最晚",
11366
+ "document": "导入数据位置,-2:最早;-1:最晚。",
11367
11367
  "example": "-1",
11368
11368
  "member": "int64",
11369
11369
  "name": "Offset",
@@ -11372,8 +11372,8 @@
11372
11372
  },
11373
11373
  {
11374
11374
  "disabled": false,
11375
- "document": "腾讯云CKafka实例ID。\nKafkaType为0KafkaInstance必填",
11376
- "example": "",
11375
+ "document": "腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。",
11376
+ "example": "ckafka-k9m5vj11",
11377
11377
  "member": "string",
11378
11378
  "name": "KafkaInstance",
11379
11379
  "required": false,
@@ -11381,7 +11381,7 @@
11381
11381
  },
11382
11382
  {
11383
11383
  "disabled": false,
11384
- "document": "服务地址。\nKafkaType为1时ServerAddr必填",
11384
+ "document": "服务地址。\nKafkaType为1时ServerAddr必填。",
11385
11385
  "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095",
11386
11386
  "member": "string",
11387
11387
  "name": "ServerAddr",
@@ -11399,7 +11399,7 @@
11399
11399
  },
11400
11400
  {
11401
11401
  "disabled": false,
11402
- "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填",
11402
+ "document": "加密访问协议。\nKafkaType为1并且IsEncryptionAddr为true时Protocol必填。",
11403
11403
  "example": "无",
11404
11404
  "member": "KafkaProtocolInfo",
11405
11405
  "name": "Protocol",
@@ -277,8 +277,8 @@
277
277
  "DeleteKafkaRecharge": [
278
278
  {
279
279
  "document": "删除Kafka导入配置",
280
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"abc\",\n \"TopicId\": \"abc\"\n}",
281
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
280
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895\",\n \"TopicId\": \"1014cc79-f006-48e4-8820-1dc727054111\"\n}",
281
+ "output": "{\n \"Response\": {\n \"RequestId\": \"00a1e648-bea8-4f85-8a7c-71f84169f207\"\n }\n}",
282
282
  "title": "删除Kafka导入配置"
283
283
  }
284
284
  ],
@@ -649,8 +649,8 @@
649
649
  "ModifyKafkaRecharge": [
650
650
  {
651
651
  "document": "修改Kafka导入配置",
652
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"xxx-xxx-xx\",\n \"TopicId\": \"abc\",\n \"Name\": \"abc\",\n \"ServerAddr\": \"abc\",\n \"IsEncryptionAddr\": true,\n \"UserKafkaTopics\": \"abc\",\n \"ConsumerGroupName\": \"abc\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"DefaultTimeSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0\n }\n}",
653
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
652
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyKafkaRecharge\n<公共请求参数>\n\n{\n \"Id\": \"1014cc79-f006-48e4-8820-1dc7270540c0\",\n \"TopicId\": \"06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111\",\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-2vrgxbxa\",\n \"ServerAddr\": \"\",\n \"IsEncryptionAddr\": false,\n \"Protocol\": {\n \"Protocol\": \"\",\n \"Mechanism\": \"\",\n \"UserName\": \"\",\n \"Password\": \"\"\n },\n \"UserKafkaTopics\": \"topic-subs-0px4qkvu32-cdb-5zi7jf11\",\n \"ConsumerGroupName\": \"\",\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"LogRegex\": \"\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogTimeSrc\": 0,\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true,\n \"DefaultTimeSrc\": 1,\n \"TimeKey\": \"\",\n \"TimeRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeZone\": \"UTC+08:00\",\n \"Metadata\": [\n \"kafka_topic\",\n \"kafka_partition\",\n \"kafka_offset\",\n \"kafka_timestamp\"\n ],\n \"Keys\": []\n }\n}",
653
+ "output": "{\n \"Response\": {\n \"RequestId\": \"0813f2a8-666f-47d4-886b-bf63bdcbc8d3\"\n }\n}",
654
654
  "title": "修改Kafka导入配置"
655
655
  }
656
656
  ],
@@ -704,10 +704,16 @@
704
704
  ],
705
705
  "PreviewKafkaRecharge": [
706
706
  {
707
- "document": "Kafka导入数据预览",
708
- "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCosRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 1,\n \"ServerAddr\": \"test.cls.tencentyun.com:9095\",\n \"IsEncryptionAddr\": false,\n \"UserKafkaTopics\": \"topic1,topic2\",\n \"Offset\": -1,\n \"LogRechargeRule\": {\n \"RechargeType\": \"json_log\",\n \"TimeKey\": \"abc\",\n \"TimeFormat\": \"abc\",\n \"LogRegex\": \"abc\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"abc\",\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true\n }\n}",
709
- "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"xxxxxxx\",\n \"LogSample\": \"abc\"\n }\n}",
707
+ "document": "源数据预览",
708
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PreviewKafkaRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 1,\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-k9m5vj75\",\n \"UserKafkaTopics\": \"topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111\",\n \"ConsumerGroupName\": \"\",\n \"Offset\": -1\n}",
709
+ "output": "{\n \"Response\": {\n \"RequestId\": \"6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx\",\n \"LogData\": \"rmap[AvailIndexTraffic:0 AvailStore:0 ClusterAvailableTrafficCapacity:0...\",\n \"LogSample\": \"\"\n }\n}",
710
710
  "title": "Kafka导入数据预览"
711
+ },
712
+ {
713
+ "document": "导出结果预览",
714
+ "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PreviewKafkaRecharge\n<公共请求参数>\n\n{\n \"PreviewType\": 2,\n \"KafkaType\": 0,\n \"KafkaInstance\": \"ckafka-l4rped7z\",\n \"UserKafkaTopics\": \"topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111\",\n \"ConsumerGroupName\": \"\",\n \"Offset\": -2,\n \"LogRechargeRule\": {\n \"RechargeType\": \"minimalist_log\",\n \"LogRegex\": \"\",\n \"UnMatchLogSwitch\": true,\n \"UnMatchLogKey\": \"LogParseFailure\",\n \"UnMatchLogTimeSrc\": 0,\n \"EncodingFormat\": 0,\n \"DefaultTimeSwitch\": true,\n \"DefaultTimeSrc\": 0,\n \"TimeKey\": \"\",\n \"TimeRegex\": \"\",\n \"TimeFormat\": \"\",\n \"TimeZone\": \"UTC+08:00\",\n \"Metadata\": [\n \"kafka_topic\",\n \"kafka_partition\",\n \"kafka_offset\",\n \"kafka_timestamp\"\n ],\n \"Keys\": []\n }\n}",
715
+ "output": "{\n \"Response\": {\n \"LogSample\": \"{\\\"x-intranet-proxy-region\\\":\\\"sh\\\",\\\"x-intranet-proxy-socket-local-address\\\":\\\"::ffff:11.179.111.111\\\",\\\"x-intranet-proxy-socket-local-port\\\":\\\"8443\\\"\",\n \"LogData\": \"{\\\"__CONTENT__\\\":\\\"{\\\\\\\"x-intranet-proxy-region\\\\\\\":\\\\\\\"sh\\\\\\\",\\\\\\\"x-intranet-proxy-socket-local-address\\\\\\\":\\\\\\\"::ffff:11.179.111.111\\\\\\\",\\\\\\\"x-intranet-proxy-socket-local-port\\\\\\\":\\\\\\\"8443\\\\\\\"\",\n \"RequestId\": \"d3218ba6-4d98-480a-a97b-8db0ae87ef31\"\n }\n}",
716
+ "title": "Kafaka导入数据预览"
711
717
  }
712
718
  ],
713
719
  "QueryMetric": [