tencentcloud-sdk-nodejs 4.0.581 → 4.0.583

package/tencentcloud/services/cls/v20201016/cls_client.js

@@ -45,6 +45,166 @@ class Client extends abstract_client_1.AbstractClient {
     async GetAlarmLog(req, cb) {
         return this.request("GetAlarmLog", req, cb);
     }
+    /**
+     * ## 提示
+为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/product/614/16873)上传日志。
+
+同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67157)。
+
+同时云API上传日志接口也支持同步上传日志数据，如果您选继续使用此接口请参考下文。
+
+## 功能描述
+
+本接口用于将日志写入到指定的日志主题。
+
+日志服务提供以下两种模式：
+
+#### 负载均衡模式
+
+系统根据当前日志主题下所有可读写的分区，遵循负载均衡原则自动分配写入的目标分区。该模式适合消费不保序的场景。
+
+#### 哈希路由模式
+
+系统根据携带的哈希值（X-CLS-HashKey）将数据写入到符合范围要求的目标分区。例如，可以将某个日志源端通过 hashkey 与某个主题分区强绑定，这样可以保证数据在该分区上写入和消费是严格保序的。
+
+                 
+
+#### 输入参数(pb二进制流，位于body中)
+
+| 字段名       | 类型    | 位置 | 必须 | 含义                                                         |
+| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
+| logGroupList | message | pb   | 是   | logGroup 列表，封装好的日志组列表内容，建议 logGroup 数量不要超过5个 |
+
+LogGroup 说明：
+
+| 字段名      | 是否必选 | 含义                                                         |
+| ----------- | -------- | ------------------------------------------------------------ |
+| logs        | 是       | 日志数组，表示有多个 Log 组成的集合，一个 Log 表示一条日志，一个 LogGroup 中 Log 个数不能超过10000 |
+| contextFlow | 否       | LogGroup 的唯一ID，需要使用上下文功能时传入。格式："{上下文ID}-{LogGroupID}"。<br>上下文ID：唯一标识一个上下文（连续滚动的一系列日志文件，或者是需要保序的一系列日志），16进制64位整型字符串。<br>LogGroupID：连续递增的一串整型，16进制64位整型字符串。样例："102700A66102516A-59F59"。                        |
+| filename    | 否       | 日志文件名                                                   |
+| source      | 否       | 日志来源，一般使用机器 IP 作为标识                           |
+| logTags     | 否       | 日志的标签列表                                               |
+
+Log 说明：
+
+| 字段名   | 是否必选 | 含义                                                         |
+| -------- | -------- | ------------------------------------------------------------ |
+| time     | 是       | 日志时间（Unix 格式时间戳），支持秒、毫秒，建议采用毫秒      |
+| contents | 否       | key-value 格式的日志内容，表示一条日志里的多个 key-value 组合 |
+
+Content 说明：
+
+| 字段名 | 是否必选 | 含义                                                         |
+| ------ | -------- | ------------------------------------------------------------ |
+| key    | 是       | 单条日志里某个字段组的 key 值，不能以`_`开头                 |
+| value  | 是       | 单条日志某个字段组的 value 值，单条日志 value 不能超过1MB，LogGroup 中所有 value 总和不能超过5MB |
+
+LogTag 说明：
+
+| 字段名 | 是否必选 | 含义                             |
+| ------ | -------- | -------------------------------- |
+| key    | 是       | 自定义的标签 key                 |
+| value  | 是       | 自定义的标签 key 对应的 value 值 |
+
+## PB 编译示例
+
+本示例将说明如何使用官方 protoc 编译工具将 PB 描述文件 编译生成为 C++ 语言可调用的上传日志接口。
+
+> ?目前 protoc 官方支持 Java、C++、Python 等语言的编译，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf)。
+
+#### 1. 安装 Protocol Buffer
+
+下载 [Protocol Buffer](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz) ，解压并安装。示例版本为 protobuf 2.6.1，环境为 Centos 7.3 系统。 解压`protobuf-2.6.1.tar.gz`压缩包至`/usr/local`目录并进入该目录，执行命令如下：
+
+```
+tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1
+```
+
+开始编译和安装，配置环境变量，执行命令如下：
+
+```
+[root@VM_0_8_centos protobuf-2.6.1]# ./configure
+[root@VM_0_8_centos protobuf-2.6.1]# make && make install
+[root@VM_0_8_centos protobuf-2.6.1]# export PATH=$PATH:/usr/local/protobuf-2.6.1/bin
+```
+
+编译成功后，您可以使用以下命令查看版本：
+
+```
+[root@VM_0_8_centos protobuf-2.6.1]# protoc --version
+liprotoc 2.6.1
+```
+
+#### 2. 创建 PB 描述文件
+
+PB 描述文件是通信双方约定的数据交换格式，上传日志时须将规定的协议格式编译成对应语言版本的调用接口，然后添加到工程代码里，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf) 。
+
+以日志服务所规定的 PB 数据格式内容为准， 在本地创建 PB 消息描述文件 cls.proto。
+
+> !PB 描述文件内容不可更改，且文件名须以`.proto`结尾。
+
+cls.proto 内容（PB 描述文件）如下：
+
+```
+package cls;
+
+message Log
+{
+    message Content
+    {
+        required string key   = 1; // 每组字段的 key
+        required string value = 2; // 每组字段的 value
+    }
+    required int64   time     = 1; // 时间戳，UNIX时间格式
+    repeated Content contents = 2; // 一条日志里的多个kv组合
+}
+
+message LogTag
+{
+    required string key       = 1;
+    required string value     = 2;
+}
+
+message LogGroup
+{
+    repeated Log    logs        = 1; // 多条日志合成的日志数组
+    optional string contextFlow = 2; // 目前暂无效用
+    optional string filename    = 3; // 日志文件名
+    optional string source      = 4; // 日志来源，一般使用机器IP
+    repeated LogTag logTags     = 5;
+}
+
+message LogGroupList
+{
+    repeated LogGroup logGroupList = 1; // 日志组列表
+}
+```
+
+#### 3. 编译生成
+
+此例中，使用 proto 编译器生成 C++ 语言的文件，在 cls.proto 文件的同一目录下，执行如下编译命令：
+
+```
+protoc --cpp_out=./ ./cls.proto
+```
+
+> ?`--cpp_out=./`表示编译成 cpp 格式并输出当前目录下，`./cls.proto`表示位于当前目录下的 cls.proto 描述文件。
+
+编译成功后，会输出对应语言的代码文件。此例会生成 cls.pb.h 头文件和 [cls.pb.cc](http://cls.pb.cc) 代码实现文件，如下所示：
+
+```
+[root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto
+[root@VM_0_8_centos protobuf-2.6.1]# ls
+cls.pb.cc cls.pb.h cls.proto
+```
+
+#### 4. 调用
+
+将生成的 cls.pb.h 头文件引入代码中，调用接口进行数据格式封装。
+     */
+    async UploadLog(req, cb) {
+        return this.request("UploadLog", req, cb);
+    }
     /**
      * 本接口用于创建投递任务
      */
@@ -281,164 +441,10 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyConfig", req, cb);
     }
     /**
-     * ## 提示
-为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/product/614/16873)上传日志。
-
-同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67157)。
-
-同时云API上传日志接口也支持同步上传日志数据，如果您选继续使用此接口请参考下文。
-
-## 功能描述
-
-本接口用于将日志写入到指定的日志主题。
-
-日志服务提供以下两种模式：
-
-#### 负载均衡模式
-
-系统根据当前日志主题下所有可读写的分区，遵循负载均衡原则自动分配写入的目标分区。该模式适合消费不保序的场景。
-
-#### 哈希路由模式
-
-系统根据携带的哈希值（X-CLS-HashKey）将数据写入到符合范围要求的目标分区。例如，可以将某个日志源端通过 hashkey 与某个主题分区强绑定，这样可以保证数据在该分区上写入和消费是严格保序的。
-
-                 
-
-#### 输入参数(pb二进制流，位于body中)
-
-| 字段名       | 类型    | 位置 | 必须 | 含义                                                         |
-| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
-| logGroupList | message | pb   | 是   | logGroup 列表，封装好的日志组列表内容，建议 logGroup 数量不要超过5个 |
-
-LogGroup 说明：
-
-| 字段名      | 是否必选 | 含义                                                         |
-| ----------- | -------- | ------------------------------------------------------------ |
-| logs        | 是       | 日志数组，表示有多个 Log 组成的集合，一个 Log 表示一条日志，一个 LogGroup 中 Log 个数不能超过10000 |
-| contextFlow | 否       | LogGroup 的唯一ID，需要使用上下文功能时传入。格式："{上下文ID}-{LogGroupID}"。<br>上下文ID：唯一标识一个上下文（连续滚动的一系列日志文件，或者是需要保序的一系列日志），16进制64位整型字符串。<br>LogGroupID：连续递增的一串整型，16进制64位整型字符串。样例："102700A66102516A-59F59"。                        |
-| filename    | 否       | 日志文件名                                                   |
-| source      | 否       | 日志来源，一般使用机器 IP 作为标识                           |
-| logTags     | 否       | 日志的标签列表                                               |
-
-Log 说明：
-
-| 字段名   | 是否必选 | 含义                                                         |
-| -------- | -------- | ------------------------------------------------------------ |
-| time     | 是       | 日志时间（Unix 格式时间戳），支持秒、毫秒，建议采用毫秒      |
-| contents | 否       | key-value 格式的日志内容，表示一条日志里的多个 key-value 组合 |
-
-Content 说明：
-
-| 字段名 | 是否必选 | 含义                                                         |
-| ------ | -------- | ------------------------------------------------------------ |
-| key    | 是       | 单条日志里某个字段组的 key 值，不能以`_`开头                 |
-| value  | 是       | 单条日志某个字段组的 value 值，单条日志 value 不能超过1MB，LogGroup 中所有 value 总和不能超过5MB |
-
-LogTag 说明：
-
-| 字段名 | 是否必选 | 含义                             |
-| ------ | -------- | -------------------------------- |
-| key    | 是       | 自定义的标签 key                 |
-| value  | 是       | 自定义的标签 key 对应的 value 值 |
-
-## PB 编译示例
-
-本示例将说明如何使用官方 protoc 编译工具将 PB 描述文件 编译生成为 C++ 语言可调用的上传日志接口。
-
-> ?目前 protoc 官方支持 Java、C++、Python 等语言的编译，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf)。
-
-#### 1. 安装 Protocol Buffer
-
-下载 [Protocol Buffer](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz) ，解压并安装。示例版本为 protobuf 2.6.1，环境为 Centos 7.3 系统。 解压`protobuf-2.6.1.tar.gz`压缩包至`/usr/local`目录并进入该目录，执行命令如下：
-
-```
-tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1
-```
-
-开始编译和安装，配置环境变量，执行命令如下：
-
-```
-[root@VM_0_8_centos protobuf-2.6.1]# ./configure
-[root@VM_0_8_centos protobuf-2.6.1]# make && make install
-[root@VM_0_8_centos protobuf-2.6.1]# export PATH=$PATH:/usr/local/protobuf-2.6.1/bin
-```
-
-编译成功后，您可以使用以下命令查看版本：
-
-```
-[root@VM_0_8_centos protobuf-2.6.1]# protoc --version
-liprotoc 2.6.1
-```
-
-#### 2. 创建 PB 描述文件
-
-PB 描述文件是通信双方约定的数据交换格式，上传日志时须将规定的协议格式编译成对应语言版本的调用接口，然后添加到工程代码里，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf) 。
-
-以日志服务所规定的 PB 数据格式内容为准， 在本地创建 PB 消息描述文件 cls.proto。
-
-> !PB 描述文件内容不可更改，且文件名须以`.proto`结尾。
-
-cls.proto 内容（PB 描述文件）如下：
-
-```
-package cls;
-
-message Log
-{
-    message Content
-    {
-        required string key   = 1; // 每组字段的 key
-        required string value = 2; // 每组字段的 value
-    }
-    required int64   time     = 1; // 时间戳，UNIX时间格式
-    repeated Content contents = 2; // 一条日志里的多个kv组合
-}
-
-message LogTag
-{
-    required string key       = 1;
-    required string value     = 2;
-}
-
-message LogGroup
-{
-    repeated Log    logs        = 1; // 多条日志合成的日志数组
-    optional string contextFlow = 2; // 目前暂无效用
-    optional string filename    = 3; // 日志文件名
-    optional string source      = 4; // 日志来源，一般使用机器IP
-    repeated LogTag logTags     = 5;
-}
-
-message LogGroupList
-{
-    repeated LogGroup logGroupList = 1; // 日志组列表
-}
-```
-
-#### 3. 编译生成
-
-此例中，使用 proto 编译器生成 C++ 语言的文件，在 cls.proto 文件的同一目录下，执行如下编译命令：
-
-```
-protoc --cpp_out=./ ./cls.proto
-```
-
-> ?`--cpp_out=./`表示编译成 cpp 格式并输出当前目录下，`./cls.proto`表示位于当前目录下的 cls.proto 描述文件。
-
-编译成功后，会输出对应语言的代码文件。此例会生成 cls.pb.h 头文件和 [cls.pb.cc](http://cls.pb.cc) 代码实现文件，如下所示：
-
-```
-[root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto
-[root@VM_0_8_centos protobuf-2.6.1]# ls
-cls.pb.cc cls.pb.h cls.proto
-```
-
-#### 4. 调用
-
-将生成的 cls.pb.h 头文件引入代码中，调用接口进行数据格式封装。
+     * 获取告警历史，例如今天未恢复的告警
      */
-    async UploadLog(req, cb) {
-        return this.request("UploadLog", req, cb);
+    async DescribeAlertRecordHistory(req, cb) {
+        return this.request("DescribeAlertRecordHistory", req, cb);
     }
     /**
      * 获取投递任务列表

package/tencentcloud/services/cls/v20201016/cls_models.d.ts

@@ -331,6 +331,45 @@ export interface CreateLogsetRequest {
       */
     Tags?: Array<Tag>;
 }
+/**
+ * DescribeShippers请求参数结构体
+ */
+export interface DescribeShippersRequest {
+    /**
+      * <br><li> shipperName
+
+按照【投递规则名称】进行过滤。
+类型：String
+
+必选：否
+
+<br><li> shipperId
+
+按照【投递规则ID】进行过滤。
+类型：String
+
+必选：否
+
+<br><li> topicId
+
+按照【日志主题】进行过滤。
+
+类型：String
+
+必选：否
+
+每次请求的Filters的上限为10，Filter.Values的上限为5。
+      */
+    Filters?: Array<Filter>;
+    /**
+      * 分页的偏移量，默认值为0
+      */
+    Offset?: number;
+    /**
+      * 分页单页的限制数目，默认值为20，最大值100
+      */
+    Limit?: number;
+}
 /**
  * 日志中的KV对
  */
@@ -1393,43 +1432,77 @@ export interface PartitionInfo {
     LastWriteTime: string;
 }
 /**
- * DescribeShippers请求参数结构体
+ * 告警历史详情
  */
-export interface DescribeShippersRequest {
+export interface AlertHistoryRecord {
     /**
-      * <br><li> shipperName
-
-按照【投递规则名称】进行过滤。
-类型：String
-
-必选：否
-
-<br><li> shipperId
-
-按照【投递规则ID】进行过滤。
-类型：String
-
-必选：否
-
-<br><li> topicId
-
-按照【日志主题】进行过滤。
-
-类型：String
-
-必选：否
-
-每次请求的Filters的上限为10，Filter.Values的上限为5。
+      * 告警历史ID
       */
-    Filters?: Array<Filter>;
+    RecordId: string;
     /**
-      * 分页的偏移量，默认值为0
+      * 告警策略ID
       */
-    Offset?: number;
+    AlarmId: string;
     /**
-      * 分页单页的限制数目，默认值为20，最大值100
+      * 告警策略名称
       */
-    Limit?: number;
+    AlarmName: string;
+    /**
+      * 监控对象ID
+      */
+    TopicId: string;
+    /**
+      * 监控对象名称
+      */
+    TopicName: string;
+    /**
+      * 监控对象所属地域
+      */
+    Region: string;
+    /**
+      * 触发条件
+      */
+    Trigger: string;
+    /**
+      * 持续周期，持续满足触发条件TriggerCount个周期后，再进行告警
+      */
+    TriggerCount: number;
+    /**
+      * 告警通知发送频率，单位为分钟
+      */
+    AlarmPeriod: number;
+    /**
+      * 通知渠道组
+      */
+    Notices: Array<AlertHistoryNotice>;
+    /**
+      * 告警持续时间，单位为分钟
+      */
+    Duration: number;
+    /**
+      * 告警状态，0代表未恢复，1代表已恢复，2代表已失效
+      */
+    Status: number;
+    /**
+      * 告警发生时间，毫秒级Unix时间戳
+      */
+    CreateTime: number;
+    /**
+      * 告警分组触发时对应的分组信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    GroupTriggerCondition?: Array<GroupTriggerConditionInfo>;
+    /**
+      * 告警级别，0代表警告(Warn)，1代表提醒(Info)，2代表紧急 (Critical)
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    AlarmLevel?: number;
+    /**
+      * 监控对象类型。
+0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    MonitorObjectType?: number;
 }
 /**
  * 黑名单path信息
@@ -2059,6 +2132,36 @@ export interface ModifyConsumerResponse {
       */
     RequestId?: string;
 }
+/**
+ * DescribeAlertRecordHistory请求参数结构体
+ */
+export interface DescribeAlertRecordHistoryRequest {
+    /**
+      * 查询时间范围启始时间，毫秒级unix时间戳
+      */
+    From: number;
+    /**
+      * 查询时间范围结束时间，毫秒级unix时间戳
+      */
+    To: number;
+    /**
+      * 分页的偏移量，默认值为0。
+      */
+    Offset: number;
+    /**
+      * 分页单页限制数目，最大值100。
+      */
+    Limit: number;
+    /**
+      * - alertId：按照告警策略ID进行过滤。类型：String 必选：否
+- topicId：按照监控对象ID进行过滤。类型：String 必选：否
+- status：按照告警状态进行过滤。类型：String 必选：否，0代表未恢复，1代表已恢复，2代表已失效
+- alarmLevel：按照告警等级进行过滤。类型：String 必选：否，0代表警告，1代表提醒，2代表紧急
+
+每次请求的Filters的上限为10，Filter.Values的上限为100。
+      */
+    Filters?: Array<Filter>;
+}
 /**
  * DescribeConfigs请求参数结构体
  */
@@ -2781,6 +2884,19 @@ export interface ExportInfo {
       */
     CreateTime: string;
 }
+/**
+ * 分组触发条件
+ */
+export interface GroupTriggerConditionInfo {
+    /**
+      * 分组触发字段名称
+      */
+    Key: string;
+    /**
+      * 分组触发字段值
+      */
+    Value: string;
+}
 /**
  * DescribeLogContext返回参数结构体
  */
@@ -3195,6 +3311,19 @@ export interface ApplyConfigToMachineGroupResponse {
       */
     RequestId?: string;
 }
+/**
+ * 告警通知渠道组详情
+ */
+export interface AlertHistoryNotice {
+    /**
+      * 通知渠道组名称
+      */
+    Name: string;
+    /**
+      * 通知渠道组ID
+      */
+    AlarmNoticeId: string;
+}
 /**
  * DeleteAlarm请求参数结构体
  */
@@ -3317,6 +3446,23 @@ export interface CreateCosRechargeResponse {
       */
     RequestId?: string;
 }
+/**
+ * DescribeAlertRecordHistory返回参数结构体
+ */
+export interface DescribeAlertRecordHistoryResponse {
+    /**
+      * 告警历史总数
+      */
+    TotalCount?: number;
+    /**
+      * 告警历史详情
+      */
+    Records?: Array<AlertHistoryRecord>;
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
+}
 /**
  * 键值或者元字段索引的字段信息
  */

package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts

@@ -52,7 +52,9 @@ export declare class Client extends AbstractClient {
      */
     DescribeVulList(req: DescribeVulListRequest, cb?: (error: string, rep: DescribeVulListResponse) => void): Promise<DescribeVulListResponse>;
     /**
-     * 导出ES查询文档列表
+     * 旧版日志下载接口下线
+
+导出ES查询文档列表
      */
     DescribeSearchExportList(req: DescribeSearchExportListRequest, cb?: (error: string, rep: DescribeSearchExportListResponse) => void): Promise<DescribeSearchExportListResponse>;
     /**

package/tencentcloud/services/cwp/v20180228/cwp_client.js

@@ -94,7 +94,9 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeVulList", req, cb);
     }
     /**
-     * 导出ES查询文档列表
+     * 旧版日志下载接口下线
+
+导出ES查询文档列表
      */
     async DescribeSearchExportList(req, cb) {
         return this.request("DescribeSearchExportList", req, cb);

package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts

@@ -2212,6 +2212,7 @@ export interface DescribeFileTamperEventsRequest {
 <li>ModifyTime - String - 是否必填：否 - 最近发生时间</li>
 <li>Uuid- String - 是否必填：否 - 主机uuid查询</li>
 <li>RuleCategory- string - 是否必填：否 - 规则类别 0 系统规则 1 自定义规则</li>
+<li>FileAction- string - 是否必填：否 - 威胁行为 read 读取文件 write 写文件</li>
       */
     Filters?: Array<Filters>;
     /**
@@ -3597,11 +3598,11 @@ export interface DescribeFileTamperEventsResponse {
       * 核心文件事件列表
 注意：此字段可能返回 null，表示取不到有效值。
       */
-    List: Array<FileTamperEvent>;
+    List?: Array<FileTamperEvent>;
     /**
       * 数据总条数
       */
-    TotalCount: number;
+    TotalCount?: number;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
@@ -8478,6 +8479,13 @@ export interface FileTamperEvent {
 注意：此字段可能返回 null，表示取不到有效值。
       */
     MachineExtraInfo?: MachineExtraInfo;
+    /**
+      * 文件威胁行为
+<li>read 读取文件</li>
+<li>write 修改文件</li>
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    FileAction?: string;
 }
 /**
  * DescribeMalwareFile返回参数结构体