tencentcloud-sdk-nodejs-intl-en 3.0.422 → 3.0.423
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/tencentcloud/cls/v20201016/cls_client.js +56 -167
- package/tencentcloud/cls/v20201016/models.js +577 -1703
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/dcdb/v20180411/dcdb_client.js +231 -62
- package/tencentcloud/dcdb/v20180411/models.js +3468 -1504
- package/tencentcloud/faceid/v20180301/faceid_client.js +2 -1
- package/tencentcloud/faceid/v20180301/models.js +6 -6
- package/tencentcloud/mongodb/v20190725/models.js +145 -15
- package/tencentcloud/mongodb/v20190725/mongodb_client.js +16 -2
- package/tencentcloud/tag/v20180813/models.js +977 -179
- package/tencentcloud/tag/v20180813/tag_client.js +215 -109
- package/tencentcloud/tcaplusdb/v20190823/models.js +78 -323
- package/tencentcloud/tcaplusdb/v20190823/tcaplusdb_client.js +9 -23
- package/tencentcloud/vod/v20180717/models.js +401 -146
- package/tencentcloud/vod/v20180717/vod_client.js +47 -2
package/package.json
CHANGED
|
@@ -21,16 +21,13 @@ const CreateAlarmResponse = models.CreateAlarmResponse;
|
|
|
21
21
|
const AlarmInfo = models.AlarmInfo;
|
|
22
22
|
const LogInfo = models.LogInfo;
|
|
23
23
|
const DeleteAlarmNoticeResponse = models.DeleteAlarmNoticeResponse;
|
|
24
|
+
const DescribeLogHistogramRequest = models.DescribeLogHistogramRequest;
|
|
24
25
|
const DescribeLogContextRequest = models.DescribeLogContextRequest;
|
|
25
26
|
const DeleteShipperRequest = models.DeleteShipperRequest;
|
|
26
|
-
const ModifyTopicRequest = models.ModifyTopicRequest;
|
|
27
27
|
const DeleteLogsetResponse = models.DeleteLogsetResponse;
|
|
28
28
|
const DescribeShipperTasksResponse = models.DescribeShipperTasksResponse;
|
|
29
29
|
const CreateMachineGroupResponse = models.CreateMachineGroupResponse;
|
|
30
30
|
const DescribeConfigMachineGroupsRequest = models.DescribeConfigMachineGroupsRequest;
|
|
31
|
-
const DescribeAsyncContextResultResponse = models.DescribeAsyncContextResultResponse;
|
|
32
|
-
const UploadLogRequest = models.UploadLogRequest;
|
|
33
|
-
const CreateAsyncContextTaskRequest = models.CreateAsyncContextTaskRequest;
|
|
34
31
|
const CreateLogsetRequest = models.CreateLogsetRequest;
|
|
35
32
|
const LogItem = models.LogItem;
|
|
36
33
|
const SearchLogResponse = models.SearchLogResponse;
|
|
@@ -39,7 +36,7 @@ const DescribePartitionsRequest = models.DescribePartitionsRequest;
|
|
|
39
36
|
const ModifyAlarmResponse = models.ModifyAlarmResponse;
|
|
40
37
|
const DescribeShipperTasksRequest = models.DescribeShipperTasksRequest;
|
|
41
38
|
const DescribeAlarmsRequest = models.DescribeAlarmsRequest;
|
|
42
|
-
const
|
|
39
|
+
const MergePartitionRequest = models.MergePartitionRequest;
|
|
43
40
|
const DescribeShippersResponse = models.DescribeShippersResponse;
|
|
44
41
|
const ModifyShipperResponse = models.ModifyShipperResponse;
|
|
45
42
|
const RetryShipperTaskRequest = models.RetryShipperTaskRequest;
|
|
@@ -48,13 +45,10 @@ const AlarmTargetInfo = models.AlarmTargetInfo;
|
|
|
48
45
|
const DescribeIndexRequest = models.DescribeIndexRequest;
|
|
49
46
|
const DescribeConfigsResponse = models.DescribeConfigsResponse;
|
|
50
47
|
const CreateLogsetResponse = models.CreateLogsetResponse;
|
|
51
|
-
const DeleteAsyncContextTaskResponse = models.DeleteAsyncContextTaskResponse;
|
|
52
48
|
const DeleteMachineGroupResponse = models.DeleteMachineGroupResponse;
|
|
53
49
|
const Tag = models.Tag;
|
|
54
|
-
const
|
|
55
|
-
const
|
|
56
|
-
const DescribeExportsRequest = models.DescribeExportsRequest;
|
|
57
|
-
const CreateAsyncSearchTaskRequest = models.CreateAsyncSearchTaskRequest;
|
|
50
|
+
const DescribeMachineGroupsRequest = models.DescribeMachineGroupsRequest;
|
|
51
|
+
const ExtractRuleInfo = models.ExtractRuleInfo;
|
|
58
52
|
const TopicInfo = models.TopicInfo;
|
|
59
53
|
const DescribeConsumerRequest = models.DescribeConsumerRequest;
|
|
60
54
|
const ShipperTaskInfo = models.ShipperTaskInfo;
|
|
@@ -82,52 +76,43 @@ const FilterRuleInfo = models.FilterRuleInfo;
|
|
|
82
76
|
const RetryShipperTaskResponse = models.RetryShipperTaskResponse;
|
|
83
77
|
const SplitPartitionRequest = models.SplitPartitionRequest;
|
|
84
78
|
const MachineGroupInfo = models.MachineGroupInfo;
|
|
85
|
-
const
|
|
86
|
-
const
|
|
79
|
+
const DescribeLogHistogramResponse = models.DescribeLogHistogramResponse;
|
|
80
|
+
const RuleTagInfo = models.RuleTagInfo;
|
|
87
81
|
const CreateIndexRequest = models.CreateIndexRequest;
|
|
88
82
|
const DeleteConsumerResponse = models.DeleteConsumerResponse;
|
|
89
83
|
const DescribeTopicsRequest = models.DescribeTopicsRequest;
|
|
90
84
|
const GetAlarmLogResponse = models.GetAlarmLogResponse;
|
|
91
|
-
const DescribeAsyncSearchTasksRequest = models.DescribeAsyncSearchTasksRequest;
|
|
92
85
|
const CreateTopicRequest = models.CreateTopicRequest;
|
|
93
|
-
const
|
|
94
|
-
const DescribeAsyncContextTasksRequest = models.DescribeAsyncContextTasksRequest;
|
|
86
|
+
const DescribeExportsRequest = models.DescribeExportsRequest;
|
|
95
87
|
const AlarmTarget = models.AlarmTarget;
|
|
96
88
|
const DeleteConfigResponse = models.DeleteConfigResponse;
|
|
97
89
|
const ModifyIndexResponse = models.ModifyIndexResponse;
|
|
98
90
|
const DeleteConsumerRequest = models.DeleteConsumerRequest;
|
|
99
91
|
const DeleteIndexRequest = models.DeleteIndexRequest;
|
|
100
92
|
const DescribeConsumerResponse = models.DescribeConsumerResponse;
|
|
101
|
-
const
|
|
102
|
-
const AsyncContextTask = models.AsyncContextTask;
|
|
93
|
+
const UploadLogRequest = models.UploadLogRequest;
|
|
103
94
|
const ModifyConsumerResponse = models.ModifyConsumerResponse;
|
|
104
95
|
const DescribeConfigsRequest = models.DescribeConfigsRequest;
|
|
105
96
|
const DeleteConfigRequest = models.DeleteConfigRequest;
|
|
106
97
|
const AnalysisDimensional = models.AnalysisDimensional;
|
|
107
98
|
const LogsetInfo = models.LogsetInfo;
|
|
108
|
-
const RuleTagInfo = models.RuleTagInfo;
|
|
109
99
|
const CreateExportRequest = models.CreateExportRequest;
|
|
110
100
|
const DescribeAlarmNoticesResponse = models.DescribeAlarmNoticesResponse;
|
|
111
101
|
const ModifyConfigRequest = models.ModifyConfigRequest;
|
|
112
102
|
const DescribeLogsetsResponse = models.DescribeLogsetsResponse;
|
|
113
103
|
const JsonInfo = models.JsonInfo;
|
|
114
|
-
const CreateShipperRequest = models.CreateShipperRequest;
|
|
115
104
|
const CreateTopicResponse = models.CreateTopicResponse;
|
|
116
105
|
const DeleteAlarmResponse = models.DeleteAlarmResponse;
|
|
117
|
-
const
|
|
106
|
+
const WebCallback = models.WebCallback;
|
|
118
107
|
const DescribeAlarmsResponse = models.DescribeAlarmsResponse;
|
|
119
108
|
const CreateAlarmNoticeResponse = models.CreateAlarmNoticeResponse;
|
|
120
|
-
const ModifyTopicResponse = models.ModifyTopicResponse;
|
|
121
109
|
const CreateConfigRequest = models.CreateConfigRequest;
|
|
122
|
-
const CreateShipperResponse = models.CreateShipperResponse;
|
|
123
110
|
const DeleteIndexResponse = models.DeleteIndexResponse;
|
|
124
|
-
const DeleteAsyncContextTaskRequest = models.DeleteAsyncContextTaskRequest;
|
|
125
111
|
const ModifyIndexRequest = models.ModifyIndexRequest;
|
|
126
112
|
const Column = models.Column;
|
|
127
113
|
const CompressInfo = models.CompressInfo;
|
|
128
114
|
const ValueInfo = models.ValueInfo;
|
|
129
115
|
const GetAlarmLogRequest = models.GetAlarmLogRequest;
|
|
130
|
-
const DescribeMachinesRequest = models.DescribeMachinesRequest;
|
|
131
116
|
const DeleteShipperResponse = models.DeleteShipperResponse;
|
|
132
117
|
const ExportInfo = models.ExportInfo;
|
|
133
118
|
const ConfigInfo = models.ConfigInfo;
|
|
@@ -136,12 +121,11 @@ const SplitPartitionResponse = models.SplitPartitionResponse;
|
|
|
136
121
|
const LogContextInfo = models.LogContextInfo;
|
|
137
122
|
const ModifyShipperRequest = models.ModifyShipperRequest;
|
|
138
123
|
const DescribeLogContextResponse = models.DescribeLogContextResponse;
|
|
139
|
-
const DescribeAsyncSearchResultRequest = models.DescribeAsyncSearchResultRequest;
|
|
140
124
|
const CreateConsumerRequest = models.CreateConsumerRequest;
|
|
141
125
|
const AlarmNotice = models.AlarmNotice;
|
|
142
126
|
const ModifyConfigResponse = models.ModifyConfigResponse;
|
|
143
127
|
const ModifyAlarmNoticeResponse = models.ModifyAlarmNoticeResponse;
|
|
144
|
-
const
|
|
128
|
+
const DescribeMachinesResponse = models.DescribeMachinesResponse;
|
|
145
129
|
const ContentInfo = models.ContentInfo;
|
|
146
130
|
const ApplyConfigToMachineGroupResponse = models.ApplyConfigToMachineGroupResponse;
|
|
147
131
|
const DeleteAlarmRequest = models.DeleteAlarmRequest;
|
|
@@ -150,15 +134,11 @@ const MachineGroupTypeInfo = models.MachineGroupTypeInfo;
|
|
|
150
134
|
const DeleteConfigFromMachineGroupRequest = models.DeleteConfigFromMachineGroupRequest;
|
|
151
135
|
const ShipperInfo = models.ShipperInfo;
|
|
152
136
|
const KeyValueInfo = models.KeyValueInfo;
|
|
153
|
-
const DeleteAsyncSearchTaskRequest = models.DeleteAsyncSearchTaskRequest;
|
|
154
137
|
const ModifyMachineGroupRequest = models.ModifyMachineGroupRequest;
|
|
155
|
-
const MergePartitionRequest = models.MergePartitionRequest;
|
|
156
138
|
const DescribeAlarmNoticesRequest = models.DescribeAlarmNoticesRequest;
|
|
157
139
|
const NoticeReceiver = models.NoticeReceiver;
|
|
158
|
-
const AsyncSearchTask = models.AsyncSearchTask;
|
|
159
140
|
const Ckafka = models.Ckafka;
|
|
160
|
-
const
|
|
161
|
-
const CreateAsyncSearchTaskResponse = models.CreateAsyncSearchTaskResponse;
|
|
141
|
+
const CreateExportResponse = models.CreateExportResponse;
|
|
162
142
|
const DeleteAlarmNoticeRequest = models.DeleteAlarmNoticeRequest;
|
|
163
143
|
const DeleteLogsetRequest = models.DeleteLogsetRequest;
|
|
164
144
|
const MachineInfo = models.MachineInfo;
|
|
@@ -172,6 +152,7 @@ const DescribeMachineGroupConfigsResponse = models.DescribeMachineGroupConfigsRe
|
|
|
172
152
|
const CsvInfo = models.CsvInfo;
|
|
173
153
|
const CreateAlarmNoticeRequest = models.CreateAlarmNoticeRequest;
|
|
174
154
|
const DescribeIndexResponse = models.DescribeIndexResponse;
|
|
155
|
+
const HistogramInfo = models.HistogramInfo;
|
|
175
156
|
const DescribeMachineGroupConfigsRequest = models.DescribeMachineGroupConfigsRequest;
|
|
176
157
|
const ModifyLogsetRequest = models.ModifyLogsetRequest;
|
|
177
158
|
const DescribeMachineGroupsResponse = models.DescribeMachineGroupsResponse;
|
|
@@ -179,7 +160,7 @@ const DescribeLogsetsRequest = models.DescribeLogsetsRequest;
|
|
|
179
160
|
const DeleteTopicResponse = models.DeleteTopicResponse;
|
|
180
161
|
const Filter = models.Filter;
|
|
181
162
|
const ConsumerContent = models.ConsumerContent;
|
|
182
|
-
const
|
|
163
|
+
const DescribeMachinesRequest = models.DescribeMachinesRequest;
|
|
183
164
|
const KeyRegexInfo = models.KeyRegexInfo;
|
|
184
165
|
const MergePartitionResponse = models.MergePartitionResponse;
|
|
185
166
|
|
|
@@ -239,36 +220,15 @@ class ClsClient extends AbstractClient {
|
|
|
239
220
|
}
|
|
240
221
|
|
|
241
222
|
/**
|
|
242
|
-
* This API is used to modify
|
|
243
|
-
* @param {ModifyTopicRequest} req
|
|
244
|
-
* @param {function(string, ModifyTopicResponse):void} cb
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
ModifyTopic(req, cb) {
|
|
248
|
-
let resp = new ModifyTopicResponse();
|
|
249
|
-
this.request("ModifyTopic", req, resp, cb);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
/**
|
|
253
|
-
* This API is used to get the result of an offline context search task.
|
|
254
|
-
* @param {DescribeAsyncContextResultRequest} req
|
|
255
|
-
* @param {function(string, DescribeAsyncContextResultResponse):void} cb
|
|
256
|
-
* @public
|
|
257
|
-
*/
|
|
258
|
-
DescribeAsyncContextResult(req, cb) {
|
|
259
|
-
let resp = new DescribeAsyncContextResultResponse();
|
|
260
|
-
this.request("DescribeAsyncContextResult", req, resp, cb);
|
|
261
|
-
}
|
|
223
|
+
* This API is used to modify the index configuration.
|
|
262
224
|
|
|
263
|
-
|
|
264
|
-
*
|
|
265
|
-
* @param {DescribeAsyncContextTasksRequest} req
|
|
266
|
-
* @param {function(string, DescribeAsyncContextTasksResponse):void} cb
|
|
225
|
+
* @param {ModifyIndexRequest} req
|
|
226
|
+
* @param {function(string, ModifyIndexResponse):void} cb
|
|
267
227
|
* @public
|
|
268
228
|
*/
|
|
269
|
-
|
|
270
|
-
let resp = new
|
|
271
|
-
this.request("
|
|
229
|
+
ModifyIndex(req, cb) {
|
|
230
|
+
let resp = new ModifyIndexResponse();
|
|
231
|
+
this.request("ModifyIndex", req, resp, cb);
|
|
272
232
|
}
|
|
273
233
|
|
|
274
234
|
/**
|
|
@@ -283,14 +243,14 @@ class ClsClient extends AbstractClient {
|
|
|
283
243
|
}
|
|
284
244
|
|
|
285
245
|
/**
|
|
286
|
-
* This API is used to
|
|
287
|
-
* @param {
|
|
288
|
-
* @param {function(string,
|
|
246
|
+
* This API is used to modify a logset.
|
|
247
|
+
* @param {ModifyLogsetRequest} req
|
|
248
|
+
* @param {function(string, ModifyLogsetResponse):void} cb
|
|
289
249
|
* @public
|
|
290
250
|
*/
|
|
291
|
-
|
|
292
|
-
let resp = new
|
|
293
|
-
this.request("
|
|
251
|
+
ModifyLogset(req, cb) {
|
|
252
|
+
let resp = new ModifyLogsetResponse();
|
|
253
|
+
this.request("ModifyLogset", req, resp, cb);
|
|
294
254
|
}
|
|
295
255
|
|
|
296
256
|
/**
|
|
@@ -337,17 +297,6 @@ class ClsClient extends AbstractClient {
|
|
|
337
297
|
this.request("CreateIndex", req, resp, cb);
|
|
338
298
|
}
|
|
339
299
|
|
|
340
|
-
/**
|
|
341
|
-
* This API is used to get the result of an offline search task.
|
|
342
|
-
* @param {DescribeAsyncSearchResultRequest} req
|
|
343
|
-
* @param {function(string, DescribeAsyncSearchResultResponse):void} cb
|
|
344
|
-
* @public
|
|
345
|
-
*/
|
|
346
|
-
DescribeAsyncSearchResult(req, cb) {
|
|
347
|
-
let resp = new DescribeAsyncSearchResultResponse();
|
|
348
|
-
this.request("DescribeAsyncSearchResult", req, resp, cb);
|
|
349
|
-
}
|
|
350
|
-
|
|
351
300
|
/**
|
|
352
301
|
* This API is used to delete a collection rule configuration.
|
|
353
302
|
* @param {DeleteConfigRequest} req
|
|
@@ -359,17 +308,6 @@ class ClsClient extends AbstractClient {
|
|
|
359
308
|
this.request("DeleteConfig", req, resp, cb);
|
|
360
309
|
}
|
|
361
310
|
|
|
362
|
-
/**
|
|
363
|
-
* This API is used to create a shipping rule. To use this API, you need to grant CLS the write permission of the specified bucket.
|
|
364
|
-
* @param {CreateShipperRequest} req
|
|
365
|
-
* @param {function(string, CreateShipperResponse):void} cb
|
|
366
|
-
* @public
|
|
367
|
-
*/
|
|
368
|
-
CreateShipper(req, cb) {
|
|
369
|
-
let resp = new CreateShipperResponse();
|
|
370
|
-
this.request("CreateShipper", req, resp, cb);
|
|
371
|
-
}
|
|
372
|
-
|
|
373
311
|
/**
|
|
374
312
|
* This API is used to modify a shipping task.
|
|
375
313
|
* @param {ModifyConsumerRequest} req
|
|
@@ -381,17 +319,6 @@ class ClsClient extends AbstractClient {
|
|
|
381
319
|
this.request("ModifyConsumer", req, resp, cb);
|
|
382
320
|
}
|
|
383
321
|
|
|
384
|
-
/**
|
|
385
|
-
* This API is used to delete an offline search task.
|
|
386
|
-
* @param {DeleteAsyncSearchTaskRequest} req
|
|
387
|
-
* @param {function(string, DeleteAsyncSearchTaskResponse):void} cb
|
|
388
|
-
* @public
|
|
389
|
-
*/
|
|
390
|
-
DeleteAsyncSearchTask(req, cb) {
|
|
391
|
-
let resp = new DeleteAsyncSearchTaskResponse();
|
|
392
|
-
this.request("DeleteAsyncSearchTask", req, resp, cb);
|
|
393
|
-
}
|
|
394
|
-
|
|
395
322
|
/**
|
|
396
323
|
* This API is used to create a notification group.
|
|
397
324
|
* @param {CreateAlarmNoticeRequest} req
|
|
@@ -513,17 +440,6 @@ class ClsClient extends AbstractClient {
|
|
|
513
440
|
this.request("DescribeAlarms", req, resp, cb);
|
|
514
441
|
}
|
|
515
442
|
|
|
516
|
-
/**
|
|
517
|
-
* This API is used to delete an offline context search task.
|
|
518
|
-
* @param {DeleteAsyncContextTaskRequest} req
|
|
519
|
-
* @param {function(string, DeleteAsyncContextTaskResponse):void} cb
|
|
520
|
-
* @public
|
|
521
|
-
*/
|
|
522
|
-
DeleteAsyncContextTask(req, cb) {
|
|
523
|
-
let resp = new DeleteAsyncContextTaskResponse();
|
|
524
|
-
this.request("DeleteAsyncContextTask", req, resp, cb);
|
|
525
|
-
}
|
|
526
|
-
|
|
527
443
|
/**
|
|
528
444
|
* This API is used to get the notification group list.
|
|
529
445
|
* @param {DescribeAlarmNoticesRequest} req
|
|
@@ -569,15 +485,14 @@ class ClsClient extends AbstractClient {
|
|
|
569
485
|
}
|
|
570
486
|
|
|
571
487
|
/**
|
|
572
|
-
* This API is used to
|
|
573
|
-
|
|
574
|
-
* @param {
|
|
575
|
-
* @param {function(string, ModifyIndexResponse):void} cb
|
|
488
|
+
* This API is used to build a histogram.
|
|
489
|
+
* @param {DescribeLogHistogramRequest} req
|
|
490
|
+
* @param {function(string, DescribeLogHistogramResponse):void} cb
|
|
576
491
|
* @public
|
|
577
492
|
*/
|
|
578
|
-
|
|
579
|
-
let resp = new
|
|
580
|
-
this.request("
|
|
493
|
+
DescribeLogHistogram(req, cb) {
|
|
494
|
+
let resp = new DescribeLogHistogramResponse();
|
|
495
|
+
this.request("DescribeLogHistogram", req, resp, cb);
|
|
581
496
|
}
|
|
582
497
|
|
|
583
498
|
/**
|
|
@@ -592,7 +507,7 @@ class ClsClient extends AbstractClient {
|
|
|
592
507
|
}
|
|
593
508
|
|
|
594
509
|
/**
|
|
595
|
-
* This API is used to search logs. It is subject to the default API rate limit, and the number of concurrent
|
|
510
|
+
* This API is used to search logs. It is subject to the default API rate limit, and the number of concurrent queries to the same log topic cannot exceed 15.
|
|
596
511
|
* @param {SearchLogRequest} req
|
|
597
512
|
* @param {function(string, SearchLogResponse):void} cb
|
|
598
513
|
* @public
|
|
@@ -614,7 +529,14 @@ class ClsClient extends AbstractClient {
|
|
|
614
529
|
}
|
|
615
530
|
|
|
616
531
|
/**
|
|
617
|
-
* ##
|
|
532
|
+
* ## Note
|
|
533
|
+
To ensure log data reliability and help you use CLS more efficiently, you are advised to use the optimized API [Uploading Structured Logs](https://intl.cloud.tencent.com/document/api/614/16873) to upload logs.
|
|
534
|
+
|
|
535
|
+
For the optimized API, we have developed an SDK (available in multiple languages) that provides features including async sending, resource control, automatic retry, graceful shutdown, and detection-based reporting. For details, see [Collection via SDK](https://intl.cloud.tencent.com/document/product/614/67157?from_cn_redirect=1).
|
|
536
|
+
|
|
537
|
+
`UploadLog` allows you to synchronously upload log data. If you still want to continue to use this API instead of the optimized one, read this document.
|
|
538
|
+
|
|
539
|
+
## Feature Description
|
|
618
540
|
|
|
619
541
|
This API is used to write logs to a specified log topic.
|
|
620
542
|
|
|
@@ -622,11 +544,11 @@ CLS provides the following two modes:
|
|
|
622
544
|
|
|
623
545
|
#### Load balancing mode
|
|
624
546
|
|
|
625
|
-
In this mode, logs will be automatically written to a target partition among all readable/writable partitions under the current log topic based on the load balancing principle. This mode is suitable for scenarios where
|
|
547
|
+
In this mode, logs will be automatically written to a target partition among all readable/writable partitions under the current log topic based on the load balancing principle. This mode is suitable for scenarios where sequential consumption is not needed.
|
|
626
548
|
|
|
627
549
|
#### Hash routing mode
|
|
628
550
|
|
|
629
|
-
In this mode, data will be written to a target partition that meets the range requirements based on the hash value (`X-CLS-HashKey`)
|
|
551
|
+
In this mode, data will be written to a target partition that meets the range requirements based on the carried hash value (`X-CLS-HashKey`). For example, a log source can be bound to a topic partition through `HashKey`, strictly guaranteeing the sequence of the data written to and consumed in this partition.
|
|
630
552
|
|
|
631
553
|
In addition, CLS allows you to upload logs in the following two modes:
|
|
632
554
|
|
|
@@ -642,7 +564,7 @@ In addition, CLS allows you to upload logs in the following two modes:
|
|
|
642
564
|
| Parameter | Required | Description |
|
|
643
565
|
| ----------- | -------- | ------------------------------------------------------------ |
|
|
644
566
|
| logs | Yes | Log array consisting of multiple `Log` values. The `Log` indicates a log, and a `LogGroup` can contain up to 10,000 `Log` values. |
|
|
645
|
-
| contextFlow | No | Unique `LogGroup` ID, which should be passed in if the context feature needs to be used. Format: "{context ID}-{LogGroupID}". <br>Context ID:
|
|
567
|
+
| contextFlow | No | Unique `LogGroup` ID, which should be passed in if the context feature needs to be used. Format: "{context ID}-{LogGroupID}". <br>Context ID: Uniquely identifies the context (a series of log files that are continuously scrolling or a series of logs that need to be sequenced), which is a 64-bit integer hex string. <br>LogGroupID: A 64-bit integer hex string that continuously increases, such as `102700A66102516A-59F59`. |
|
|
646
568
|
| filename | No | Log filename |
|
|
647
569
|
| source | No | Log source, which is generally the machine IP |
|
|
648
570
|
| logTags | No | Tag list of logs |
|
|
@@ -672,11 +594,11 @@ In addition, CLS allows you to upload logs in the following two modes:
|
|
|
672
594
|
|
|
673
595
|
This sample describes how to use the protoc compiler to compile the pb description file into a log upload API in C++.
|
|
674
596
|
|
|
675
|
-
> ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information,
|
|
597
|
+
> ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
|
|
676
598
|
|
|
677
599
|
#### 1. Install Protocol Buffers
|
|
678
600
|
|
|
679
|
-
Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the sample is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and
|
|
601
|
+
Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the sample is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and go to the directory:
|
|
680
602
|
|
|
681
603
|
```
|
|
682
604
|
tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1
|
|
@@ -699,7 +621,7 @@ liprotoc 2.6.1
|
|
|
699
621
|
|
|
700
622
|
#### 2. Create a pb description file
|
|
701
623
|
|
|
702
|
-
A pb description file is an agreed-on data interchange format for communication. To upload logs,
|
|
624
|
+
A pb description file is an agreed-on data interchange format for communication. To upload logs, compile the specified protocol format to an API in the target programming language and add the API to the project code. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
|
|
703
625
|
|
|
704
626
|
Create a pb message description file `cls.proto` based on the pb data format content specified by CLS.
|
|
705
627
|
|
|
@@ -744,7 +666,7 @@ message LogGroupList
|
|
|
744
666
|
|
|
745
667
|
#### 3. Compile and generate the API
|
|
746
668
|
|
|
747
|
-
This sample uses the proto compiler to generate a C++ file in the same directory as the `cls.proto` file. Run the following compilation
|
|
669
|
+
This sample uses the proto compiler to generate a C++ file in the same directory as the `cls.proto` file. Run the following compilation command:
|
|
748
670
|
|
|
749
671
|
```
|
|
750
672
|
protoc --cpp_out=./ ./cls.proto
|
|
@@ -752,7 +674,7 @@ protoc --cpp_out=./ ./cls.proto
|
|
|
752
674
|
|
|
753
675
|
> ?`--cpp_out=./ ` indicates that the file will be compiled in cpp format and output to the current directory. `./cls.proto` indicates the `cls.proto` description file in the current directory.
|
|
754
676
|
|
|
755
|
-
After the compilation succeeds, the code file in the corresponding programming language will be generated. This sample generates the `cls.pb.h` header file and
|
|
677
|
+
After the compilation succeeds, the code file in the corresponding programming language will be generated. This sample generates the `cls.pb.h` header file and [cls.pb.cc](http://cls.pb.cc) code implementation file as shown below:
|
|
756
678
|
|
|
757
679
|
```
|
|
758
680
|
[root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto
|
|
@@ -773,14 +695,14 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
773
695
|
}
|
|
774
696
|
|
|
775
697
|
/**
|
|
776
|
-
* This API is used to
|
|
777
|
-
* @param {
|
|
778
|
-
* @param {function(string,
|
|
698
|
+
* This API is used to get the list of shipping tasks.
|
|
699
|
+
* @param {DescribeShipperTasksRequest} req
|
|
700
|
+
* @param {function(string, DescribeShipperTasksResponse):void} cb
|
|
779
701
|
* @public
|
|
780
702
|
*/
|
|
781
|
-
|
|
782
|
-
let resp = new
|
|
783
|
-
this.request("
|
|
703
|
+
DescribeShipperTasks(req, cb) {
|
|
704
|
+
let resp = new DescribeShipperTasksResponse();
|
|
705
|
+
this.request("DescribeShipperTasks", req, resp, cb);
|
|
784
706
|
}
|
|
785
707
|
|
|
786
708
|
/**
|
|
@@ -828,7 +750,7 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
828
750
|
}
|
|
829
751
|
|
|
830
752
|
/**
|
|
831
|
-
* This API is used to delete the index configuration of a log topic.
|
|
753
|
+
* This API is used to delete the index configuration of a log topic. After deleting, you cannot retrieve or query the collected logs.
|
|
832
754
|
* @param {DeleteIndexRequest} req
|
|
833
755
|
* @param {function(string, DeleteIndexResponse):void} cb
|
|
834
756
|
* @public
|
|
@@ -838,17 +760,6 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
838
760
|
this.request("DeleteIndex", req, resp, cb);
|
|
839
761
|
}
|
|
840
762
|
|
|
841
|
-
/**
|
|
842
|
-
* This API is used to get the list of offline search tasks.
|
|
843
|
-
* @param {DescribeAsyncSearchTasksRequest} req
|
|
844
|
-
* @param {function(string, DescribeAsyncSearchTasksResponse):void} cb
|
|
845
|
-
* @public
|
|
846
|
-
*/
|
|
847
|
-
DescribeAsyncSearchTasks(req, cb) {
|
|
848
|
-
let resp = new DescribeAsyncSearchTasksResponse();
|
|
849
|
-
this.request("DescribeAsyncSearchTasks", req, resp, cb);
|
|
850
|
-
}
|
|
851
|
-
|
|
852
763
|
/**
|
|
853
764
|
* This API is used to delete an alarm policy.
|
|
854
765
|
* @param {DeleteAlarmRequest} req
|
|
@@ -937,17 +848,6 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
937
848
|
this.request("DescribeConfigMachineGroups", req, resp, cb);
|
|
938
849
|
}
|
|
939
850
|
|
|
940
|
-
/**
|
|
941
|
-
* This API is used to modify a logset.
|
|
942
|
-
* @param {ModifyLogsetRequest} req
|
|
943
|
-
* @param {function(string, ModifyLogsetResponse):void} cb
|
|
944
|
-
* @public
|
|
945
|
-
*/
|
|
946
|
-
ModifyLogset(req, cb) {
|
|
947
|
-
let resp = new ModifyLogsetResponse();
|
|
948
|
-
this.request("ModifyLogset", req, resp, cb);
|
|
949
|
-
}
|
|
950
|
-
|
|
951
851
|
/**
|
|
952
852
|
* This API is used to delete a log download task.
|
|
953
853
|
* @param {DeleteExportRequest} req
|
|
@@ -982,7 +882,7 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
982
882
|
}
|
|
983
883
|
|
|
984
884
|
/**
|
|
985
|
-
* This API is used to create a
|
|
885
|
+
* This API is used to create a download task to export raw logs.
|
|
986
886
|
* @param {CreateExportRequest} req
|
|
987
887
|
* @param {function(string, CreateExportResponse):void} cb
|
|
988
888
|
* @public
|
|
@@ -1003,17 +903,6 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
|
|
|
1003
903
|
this.request("SplitPartition", req, resp, cb);
|
|
1004
904
|
}
|
|
1005
905
|
|
|
1006
|
-
/**
|
|
1007
|
-
* This API is used to create an offline search task.
|
|
1008
|
-
* @param {CreateAsyncSearchTaskRequest} req
|
|
1009
|
-
* @param {function(string, CreateAsyncSearchTaskResponse):void} cb
|
|
1010
|
-
* @public
|
|
1011
|
-
*/
|
|
1012
|
-
CreateAsyncSearchTask(req, cb) {
|
|
1013
|
-
let resp = new CreateAsyncSearchTaskResponse();
|
|
1014
|
-
this.request("CreateAsyncSearchTask", req, resp, cb);
|
|
1015
|
-
}
|
|
1016
|
-
|
|
1017
906
|
|
|
1018
907
|
}
|
|
1019
908
|
module.exports = ClsClient;
|