tencentcloud-sdk-nodejs-intl-en 3.0.916 → 3.0.918

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-intl-en",
3
- "version": "3.0.916",
3
+ "version": "3.0.918",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -275,7 +275,7 @@ class ClsClient extends AbstractClient {
275
275
  }
276
276
 
277
277
  /**
278
- * Modifies Kafka Protocol consumption information
278
+ * This API is used to modify Kafka protocol consumption information.
279
279
  * @param {ModifyKafkaConsumerRequest} req
280
280
  * @param {function(string, ModifyKafkaConsumerResponse):void} cb
281
281
  * @public
@@ -319,7 +319,7 @@ class ClsClient extends AbstractClient {
319
319
  }
320
320
 
321
321
  /**
322
- * Queries the latest metric value at a specified time
322
+ * This API is used to query the latest metric value at a specified time.
323
323
  * @param {QueryMetricRequest} req
324
324
  * @param {function(string, QueryMetricResponse):void} cb
325
325
  * @public
@@ -341,7 +341,7 @@ class ClsClient extends AbstractClient {
341
341
  }
342
342
 
343
343
  /**
344
- * This API is used to get a collection rule configuration.
344
+ * This API is used to get collection rule configuration.
345
345
  * @param {DescribeConfigsRequest} req
346
346
  * @param {function(string, DescribeConfigsResponse):void} cb
347
347
  * @public
@@ -451,7 +451,7 @@ class ClsClient extends AbstractClient {
451
451
  }
452
452
 
453
453
  /**
454
- * This API is used to create a collection rule configuration.
454
+ * This API is used to create collection rule configuration.
455
455
  * @param {CreateConfigRequest} req
456
456
  * @param {function(string, CreateConfigResponse):void} cb
457
457
  * @public
@@ -506,7 +506,7 @@ class ClsClient extends AbstractClient {
506
506
  }
507
507
 
508
508
  /**
509
- * This API is used to delete scheduled SQL analysis tasks.
509
+ * This API is used to delete a scheduled SQL analysis task.
510
510
  * @param {DeleteScheduledSqlRequest} req
511
511
  * @param {function(string, DeleteScheduledSqlResponse):void} cb
512
512
  * @public
@@ -517,7 +517,7 @@ class ClsClient extends AbstractClient {
517
517
  }
518
518
 
519
519
  /**
520
- * This API is used to create a download task. To get the returned download address, call `DescribeExports` to view the task list. The `CosPath` parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
520
+ * This API is used to create a download task. To get the returned download address, call DescribeExports to view the task list. The CosPath parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
521
521
  * @param {CreateExportRequest} req
522
522
  * @param {function(string, CreateExportResponse):void} cb
523
523
  * @public
@@ -583,7 +583,7 @@ class ClsClient extends AbstractClient {
583
583
  }
584
584
 
585
585
  /**
586
- * This API is used to modify a CKafka delivery task
586
+ * This API is used to modify a CKafka delivery task.
587
587
  * @param {ModifyConsumerRequest} req
588
588
  * @param {function(string, ModifyConsumerResponse):void} cb
589
589
  * @public
@@ -649,7 +649,7 @@ class ClsClient extends AbstractClient {
649
649
  }
650
650
 
651
651
  /**
652
- * This API is used to apply the collection configuration to the specified machine group.
652
+ * This API is used to apply the collection configuration to a specified machine group.
653
653
  * @param {ApplyConfigToMachineGroupRequest} req
654
654
  * @param {function(string, ApplyConfigToMachineGroupResponse):void} cb
655
655
  * @public
@@ -671,7 +671,7 @@ class ClsClient extends AbstractClient {
671
671
  }
672
672
 
673
673
  /**
674
- * This API is used to get a log count histogram.
674
+ * This API is used to get a log count histogram.
675
675
  * @param {DescribeLogHistogramRequest} req
676
676
  * @param {function(string, DescribeLogHistogramResponse):void} cb
677
677
  * @public
@@ -726,7 +726,7 @@ class ClsClient extends AbstractClient {
726
726
  }
727
727
 
728
728
  /**
729
- * Accesses Kafka protocol consumption information
729
+ * This API is used to access Kafka protocol consumption information.
730
730
  * @param {DescribeKafkaConsumerRequest} req
731
731
  * @param {function(string, DescribeKafkaConsumerResponse):void} cb
732
732
  * @public
@@ -759,7 +759,7 @@ class ClsClient extends AbstractClient {
759
759
  }
760
760
 
761
761
  /**
762
- * Accesses alarm blocking configuration rules
762
+ * This API is used to access alarm blocking configuration rules.
763
763
  * @param {DescribeAlarmShieldsRequest} req
764
764
  * @param {function(string, DescribeAlarmShieldsResponse):void} cb
765
765
  * @public
@@ -770,7 +770,7 @@ class ClsClient extends AbstractClient {
770
770
  }
771
771
 
772
772
  /**
773
- * This API is used to modify scheduled SQL analysis tasks.
773
+ * This API is used to modify a scheduled SQL analysis task.
774
774
  * @param {ModifyScheduledSqlRequest} req
775
775
  * @param {function(string, ModifyScheduledSqlResponse):void} cb
776
776
  * @public
@@ -957,7 +957,7 @@ class ClsClient extends AbstractClient {
957
957
  }
958
958
 
959
959
  /**
960
- * This API is used to get the machine group bound to a collection rule configuration.
960
+ * This API is used to get the machine group bound to collection rule configuration.
961
961
  * @param {DescribeConfigMachineGroupsRequest} req
962
962
  * @param {function(string, DescribeConfigMachineGroupsResponse):void} cb
963
963
  * @public
@@ -1045,7 +1045,7 @@ class ClsClient extends AbstractClient {
1045
1045
  }
1046
1046
 
1047
1047
  /**
1048
- * This API is used to delete a collection rule configuration.
1048
+ * This API is used to delete collection rule configuration.
1049
1049
  * @param {DeleteConfigRequest} req
1050
1050
  * @param {function(string, DeleteConfigResponse):void} cb
1051
1051
  * @public
@@ -1078,7 +1078,7 @@ class ClsClient extends AbstractClient {
1078
1078
  }
1079
1079
 
1080
1080
  /**
1081
- * This API is used to get the configuration of the task of shipping to COS.
1081
+ * This API is used to get the configuration of the task shipped to COS.
1082
1082
  * @param {DescribeShippersRequest} req
1083
1083
  * @param {function(string, DescribeShippersResponse):void} cb
1084
1084
  * @public
@@ -1100,7 +1100,7 @@ class ClsClient extends AbstractClient {
1100
1100
  }
1101
1101
 
1102
1102
  /**
1103
- * This API is used to modify a collection rule configuration.
1103
+ * This API is used to modify collection rule configuration.
1104
1104
  * @param {ModifyConfigRequest} req
1105
1105
  * @param {function(string, ModifyConfigResponse):void} cb
1106
1106
  * @public
@@ -1177,7 +1177,7 @@ This example shows you how to use the protoc compiler to compile a pb descriptio
1177
1177
 
1178
1178
  > ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
1179
1179
 
1180
- #### 1. Install Protocol Buffers
1180
+ #### 1. Install protocol buffers
1181
1181
 
1182
1182
  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 example 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:
1183
1183
 
@@ -1343,7 +1343,7 @@ Import the generated `cls.pb.h` header file into the code and call the API for d
1343
1343
  }
1344
1344
 
1345
1345
  /**
1346
- * Gets the status of a machine under the specified machine group
1346
+ * This API is used to get the status of a machine under the specified machine group.
1347
1347
  * @param {DescribeMachinesRequest} req
1348
1348
  * @param {function(string, DescribeMachinesResponse):void} cb
1349
1349
  * @public
@@ -434,7 +434,7 @@ class DescribeLogHistogramRequest extends AbstractModel {
434
434
  this.TopicId = null;
435
435
 
436
436
  /**
437
- * Interval in milliseconds. Condition: (ToFrom) / Interval 200
437
+ * Interval in milliseconds. Condition: (To-From) / Interval <= 200
438
438
  * @type {number || null}
439
439
  */
440
440
  this.Interval = null;
@@ -825,7 +825,7 @@ class CheckFunctionRequest extends AbstractModel {
825
825
  super();
826
826
 
827
827
  /**
828
- * The processing statement entered by the user
828
+ * Processing statement entered by the user
829
829
  * @type {string || null}
830
830
  */
831
831
  this.EtlContent = null;
@@ -837,7 +837,7 @@ class CheckFunctionRequest extends AbstractModel {
837
837
  this.DstResources = null;
838
838
 
839
839
  /**
840
- * The type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)
840
+ * Type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)
841
841
  * @type {number || null}
842
842
  */
843
843
  this.FuncType = null;
@@ -996,7 +996,7 @@ class SearchCosRechargeInfoRequest extends AbstractModel {
996
996
  this.Prefix = null;
997
997
 
998
998
  /**
999
- * Compression mode: "", "gzip", "lzop", and "snappy”. The default mode is "".
999
+ * Compression mode: "", "gzip", "lzop", and "snappy". The default mode is "".
1000
1000
  * @type {string || null}
1001
1001
  */
1002
1002
  this.Compress = null;
@@ -2037,7 +2037,7 @@ class DescribeKafkaConsumerResponse extends AbstractModel {
2037
2037
  this.TopicID = null;
2038
2038
 
2039
2039
  /**
2040
- * Compression mode [0:NONE2:SNAPPY3:LZ4]
2040
+ * Compression mode [0: NONE; 2: SNAPPY; 3: LZ4]
2041
2041
  * @type {number || null}
2042
2042
  */
2043
2043
  this.Compression = null;
@@ -3586,7 +3586,7 @@ class ModifyConsumerRequest extends AbstractModel {
3586
3586
  this.Ckafka = null;
3587
3587
 
3588
3588
  /**
3589
- * Compression method during delivery. Valid values: 0, 2, and 3. [0NONE2SNAPPY3LZ4]
3589
+ * Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4]
3590
3590
  * @type {number || null}
3591
3591
  */
3592
3592
  this.Compression = null;
@@ -4055,7 +4055,7 @@ class ModifyAlarmRequest extends AbstractModel {
4055
4055
  this.MonitorTime = null;
4056
4056
 
4057
4057
  /**
4058
- * Trigger condition.Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4058
+ * Trigger condition. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4059
4059
  * @type {string || null}
4060
4060
  */
4061
4061
  this.Condition = null;
@@ -4063,25 +4063,25 @@ class ModifyAlarmRequest extends AbstractModel {
4063
4063
  /**
4064
4064
  * Alarm level.0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical)
4065
4065
 
4066
- Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4066
+ Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4067
4067
  * @type {number || null}
4068
4068
  */
4069
4069
  this.AlarmLevel = null;
4070
4070
 
4071
4071
  /**
4072
- * Multiple ttrigger conditions.Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4072
+ * Multiple trigger conditions. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
4073
4073
  * @type {Array.<MultiCondition> || null}
4074
4074
  */
4075
4075
  this.MultiConditions = null;
4076
4076
 
4077
4077
  /**
4078
- * Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 110.
4078
+ * Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1 to 10
4079
4079
  * @type {number || null}
4080
4080
  */
4081
4081
  this.TriggerCount = null;
4082
4082
 
4083
4083
  /**
4084
- * Repeated alarm interval in minutes. Value range: 01440.
4084
+ * Repeated alarm interval in minutes. Value range: 0 to 1440
4085
4085
  * @type {number || null}
4086
4086
  */
4087
4087
  this.AlarmPeriod = null;
@@ -4129,7 +4129,7 @@ Note:- Condition and AlarmLevel are one set of configurations, MultiConditions i
4129
4129
  this.Analysis = null;
4130
4130
 
4131
4131
  /**
4132
- * Group trigger status. true: enabled, false: disabled (default)
4132
+ * Group trigger status. true: enabled; false: disabled (default)
4133
4133
  * @type {boolean || null}
4134
4134
  */
4135
4135
  this.GroupTriggerStatus = null;
@@ -5088,7 +5088,7 @@ class ModifyKafkaConsumerRequest extends AbstractModel {
5088
5088
  this.FromTopicId = null;
5089
5089
 
5090
5090
  /**
5091
- * Compression mode [0:NONE2:SNAPPY3:LZ4]
5091
+ * Compression mode [0: NONE; 2: SNAPPY; 3: LZ4]
5092
5092
  * @type {number || null}
5093
5093
  */
5094
5094
  this.Compression = null;
@@ -5953,7 +5953,7 @@ class CreateTopicRequest extends AbstractModel {
5953
5953
  this.StorageType = null;
5954
5954
 
5955
5955
  /**
5956
- * lifetime. Unit: days. Standard storage value range: 1~3600. Infrequent storage value range: 7~3600 days. A value of 3640 indicates permanent retention.If this value is not input, it defaults to the Period value of the log set corresponding to the accessed log topic (defaults to 30 days in case of access failure).
5956
+ * lifetime. Unit: days. Standard storage value range: 1 to 3600. Infrequent storage value range: 7 to 3600 days. A value of 3640 indicates permanent retention.If this value is not input, it defaults to the Period value of the log set corresponding to the accessed log topic (defaults to 30 days in case of access failure).
5957
5957
  * @type {number || null}
5958
5958
  */
5959
5959
  this.Period = null;
@@ -6287,7 +6287,7 @@ class ModifyScheduledSqlRequest extends AbstractModel {
6287
6287
  this.TaskId = null;
6288
6288
 
6289
6289
  /**
6290
- * Source Log Topic
6290
+ * Source log topic
6291
6291
  * @type {string || null}
6292
6292
  */
6293
6293
  this.SrcTopicId = null;
@@ -7292,7 +7292,7 @@ class CloseKafkaConsumerRequest extends AbstractModel {
7292
7292
  super();
7293
7293
 
7294
7294
  /**
7295
- * Log Topic ID
7295
+ * Log topic ID
7296
7296
  * @type {string || null}
7297
7297
  */
7298
7298
  this.FromTopicId = null;
@@ -9311,13 +9311,13 @@ class CheckFunctionResponse extends AbstractModel {
9311
9311
  super();
9312
9312
 
9313
9313
  /**
9314
- * Failure Error Code
9314
+ * Failure error code
9315
9315
  * @type {number || null}
9316
9316
  */
9317
9317
  this.ErrorCode = null;
9318
9318
 
9319
9319
  /**
9320
- * Failure Error Message
9320
+ * Failure error message
9321
9321
  * @type {string || null}
9322
9322
  */
9323
9323
  this.ErrorMsg = null;
@@ -9694,13 +9694,13 @@ class ModifyShipperRequest extends AbstractModel {
9694
9694
  this.ShipperName = null;
9695
9695
 
9696
9696
  /**
9697
- * Shipping time interval in seconds. Default value: 300. Value range: 300900
9697
+ * Shipping time interval in seconds. Default value: 300. Value range: 300 to 900
9698
9698
  * @type {number || null}
9699
9699
  */
9700
9700
  this.Interval = null;
9701
9701
 
9702
9702
  /**
9703
- * Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 5-256
9703
+ * Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 5 to 256
9704
9704
  * @type {number || null}
9705
9705
  */
9706
9706
  this.MaxSize = null;
@@ -9736,7 +9736,7 @@ class ModifyShipperRequest extends AbstractModel {
9736
9736
  this.FilenameMode = null;
9737
9737
 
9738
9738
  /**
9739
- * COS Bucket Type
9739
+ * COS bucket type
9740
9740
  * @type {string || null}
9741
9741
  */
9742
9742
  this.StorageType = null;
@@ -10069,7 +10069,7 @@ class CreateConsumerRequest extends AbstractModel {
10069
10069
  this.Ckafka = null;
10070
10070
 
10071
10071
  /**
10072
- * Compression method during delivery. Valid values: 0, 2, and 3. [0NONE2SNAPPY3LZ4]
10072
+ * Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4]
10073
10073
  * @type {number || null}
10074
10074
  */
10075
10075
  this.Compression = null;
@@ -11762,7 +11762,7 @@ class ModifyTopicRequest extends AbstractModel {
11762
11762
  this.MaxSplitPartitions = null;
11763
11763
 
11764
11764
  /**
11765
- * Lifecycle in days. Value range: 13600 (STANDARD storage); 73600 (IA storage). `3640` indicates permanent retention.
11765
+ * Lifecycle in days. Value range: 1 to 3600 (STANDARD storage); 7 to 3600 (IA storage). 3640 indicates permanent retention.
11766
11766
  * @type {number || null}
11767
11767
  */
11768
11768
  this.Period = null;
@@ -12287,7 +12287,7 @@ Notes:
12287
12287
  /**
12288
12288
  * Indicates whether to sample raw logs before statistical analysis (`Query` includes SQL statements).
12289
12289
  `0`: Auto-sample.
12290
- `01`: Sample by the specified sample rate, such as `0.02`.
12290
+ `0-1`: Sample by the specified sample rate, such as `0.02`.
12291
12291
  `1`: Precise analysis without sampling.
12292
12292
  Default value: `1`
12293
12293
  * @type {number || null}
@@ -14052,13 +14052,13 @@ class CreateScheduledSqlRequest extends AbstractModel {
14052
14052
  super();
14053
14053
 
14054
14054
  /**
14055
- * Source Log Topic
14055
+ * Source log topic
14056
14056
  * @type {string || null}
14057
14057
  */
14058
14058
  this.SrcTopicId = null;
14059
14059
 
14060
14060
  /**
14061
- * Task Name
14061
+ * Task name
14062
14062
  * @type {string || null}
14063
14063
  */
14064
14064
  this.Name = null;
@@ -14076,25 +14076,25 @@ class CreateScheduledSqlRequest extends AbstractModel {
14076
14076
  this.DstResource = null;
14077
14077
 
14078
14078
  /**
14079
- * Query Statement
14079
+ * Query statement
14080
14080
  * @type {string || null}
14081
14081
  */
14082
14082
  this.ScheduledSqlContent = null;
14083
14083
 
14084
14084
  /**
14085
- * Schedule Start Time, Unix timestamp, in milliseconds
14085
+ * Schedule start time, Unix timestamp, in milliseconds
14086
14086
  * @type {number || null}
14087
14087
  */
14088
14088
  this.ProcessStartTime = null;
14089
14089
 
14090
14090
  /**
14091
- * Schedule Type: 1 Continuous Running 2 Specified Time Range
14091
+ * Schedule type: 1: Continuous running; 2: Specified time range
14092
14092
  * @type {number || null}
14093
14093
  */
14094
14094
  this.ProcessType = null;
14095
14095
 
14096
14096
  /**
14097
- * Scheduling Interval (Minutes)
14097
+ * Scheduling interval (minutes)
14098
14098
  * @type {number || null}
14099
14099
  */
14100
14100
  this.ProcessPeriod = null;
@@ -14106,19 +14106,19 @@ class CreateScheduledSqlRequest extends AbstractModel {
14106
14106
  this.ProcessTimeWindow = null;
14107
14107
 
14108
14108
  /**
14109
- * Execution Delay (Seconds)
14109
+ * Execution delay (Seconds)
14110
14110
  * @type {number || null}
14111
14111
  */
14112
14112
  this.ProcessDelay = null;
14113
14113
 
14114
14114
  /**
14115
- * Source Topic ID Region Information
14115
+ * Source topic ID region information
14116
14116
  * @type {string || null}
14117
14117
  */
14118
14118
  this.SrcTopicRegion = null;
14119
14119
 
14120
14120
  /**
14121
- * Schedule End Time. Required field when ProcessType=2, Unix timestamp, in milliseconds
14121
+ * Schedule end time. Required field when ProcessType=2, Unix timestamp, in milliseconds
14122
14122
  * @type {number || null}
14123
14123
  */
14124
14124
  this.ProcessEndTime = null;
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.916";
1
+ const sdkVersion = "3.0.918";
2
2
  module.exports = sdkVersion