tencentcloud-sdk-nodejs 4.0.581 → 4.0.583

package/src/services/cls/v20201016/cls_client.ts

@@ -36,6 +36,7 @@ import {
   DescribeConfigMachineGroupsRequest,
   ModifyConfigExtraResponse,
   CreateLogsetRequest,
+  DescribeShippersRequest,
   LogItem,
   SearchLogResponse,
   DeleteTopicRequest,
@@ -83,7 +84,7 @@ import {
   CreateAlarmRequest,
   DeleteExportResponse,
   PartitionInfo,
-  DescribeShippersRequest,
+  AlertHistoryRecord,
   ExcludePathInfo,
   FilterRuleInfo,
   ConfigExtraInfo,
@@ -111,6 +112,7 @@ import {
   DescribeConsumerResponse,
   UploadLogRequest,
   ModifyConsumerResponse,
+  DescribeAlertRecordHistoryRequest,
   DescribeConfigsRequest,
   LogsetInfo,
   DeleteConfigRequest,
@@ -143,6 +145,7 @@ import {
   GetAlarmLogRequest,
   DeleteShipperResponse,
   ExportInfo,
+  GroupTriggerConditionInfo,
   DescribeLogContextResponse,
   ConfigInfo,
   DeleteExportRequest,
@@ -158,12 +161,14 @@ import {
   ModifyCosRechargeResponse,
   CompressInfo,
   ApplyConfigToMachineGroupResponse,
+  AlertHistoryNotice,
   DeleteAlarmRequest,
   CreateConfigResponse,
   MachineGroupTypeInfo,
   DeleteConfigFromMachineGroupRequest,
   ShipperInfo,
   CreateCosRechargeResponse,
+  DescribeAlertRecordHistoryResponse,
   KeyValueInfo,
   AddMachineGroupInfoResponse,
   ModifyMachineGroupRequest,
@@ -242,6 +247,170 @@ export class Client extends AbstractClient {
     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: UploadLogRequest,
+    cb?: (error: string, rep: UploadLogResponse) => void
+  ): Promise<UploadLogResponse> {
+    return this.request("UploadLog", req, cb)
+  }
+
   /**
    * 本接口用于创建投递任务
    */
@@ -634,167 +803,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * ## 提示
-为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用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: UploadLogRequest,
-    cb?: (error: string, rep: UploadLogResponse) => void
-  ): Promise<UploadLogResponse> {
-    return this.request("UploadLog", req, cb)
+   * 获取告警历史，例如今天未恢复的告警
+   */
+  async DescribeAlertRecordHistory(
+    req: DescribeAlertRecordHistoryRequest,
+    cb?: (error: string, rep: DescribeAlertRecordHistoryResponse) => void
+  ): Promise<DescribeAlertRecordHistoryResponse> {
+    return this.request("DescribeAlertRecordHistory", req, cb)
   }
 
   /**

package/src/services/cls/v20201016/cls_models.ts

@@ -406,6 +406,48 @@ 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对
  */
@@ -1649,45 +1691,92 @@ export interface PartitionInfo {
 }
 
 /**
- * DescribeShippers请求参数结构体
+ * 告警历史详情
  */
-export interface DescribeShippersRequest {
+export interface AlertHistoryRecord {
   /**
-      * <br><li> shipperName
+   * 告警历史ID
+   */
+  RecordId: string
 
-按照【投递规则名称】进行过滤。
-类型：String
+  /**
+   * 告警策略ID
+   */
+  AlarmId: string
 
-必选：否
+  /**
+   * 告警策略名称
+   */
+  AlarmName: string
 
-<br><li> shipperId
+  /**
+   * 监控对象ID
+   */
+  TopicId: string
 
-按照【投递规则ID】进行过滤。
-类型：String
+  /**
+   * 监控对象名称
+   */
+  TopicName: string
 
-必选：否
+  /**
+   * 监控对象所属地域
+   */
+  Region: string
 
-<br><li> topicId
+  /**
+   * 触发条件
+   */
+  Trigger: string
 
-按照【日志主题】进行过滤。
+  /**
+   * 持续周期，持续满足触发条件TriggerCount个周期后，再进行告警
+   */
+  TriggerCount: number
 
-类型：String
+  /**
+   * 告警通知发送频率，单位为分钟
+   */
+  AlarmPeriod: number
 
-必选：否
+  /**
+   * 通知渠道组
+   */
+  Notices: Array<AlertHistoryNotice>
 
-每次请求的Filters的上限为10，Filter.Values的上限为5。
-      */
-  Filters?: Array<Filter>
+  /**
+   * 告警持续时间，单位为分钟
+   */
+  Duration: number
 
   /**
-   * 分页的偏移量，默认值为0
+   * 告警状态，0代表未恢复，1代表已恢复，2代表已失效
    */
-  Offset?: number
+  Status: number
 
   /**
-   * 分页单页的限制数目，默认值为20，最大值100
+   * 告警发生时间，毫秒级Unix时间戳
    */
-  Limit?: number
+  CreateTime: number
+
+  /**
+      * 告警分组触发时对应的分组信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  GroupTriggerCondition?: Array<GroupTriggerConditionInfo>
+
+  /**
+      * 告警级别，0代表警告(Warn)，1代表提醒(Info)，2代表紧急 (Critical)
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  AlarmLevel?: number
+
+  /**
+      * 监控对象类型。
+0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MonitorObjectType?: number
 }
 
 /**
@@ -2426,6 +2515,41 @@ 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请求参数结构体
  */
@@ -3275,6 +3399,21 @@ export interface ExportInfo {
   CreateTime: string
 }
 
+/**
+ * 分组触发条件
+ */
+export interface GroupTriggerConditionInfo {
+  /**
+   * 分组触发字段名称
+   */
+  Key: string
+
+  /**
+   * 分组触发字段值
+   */
+  Value: string
+}
+
 /**
  * DescribeLogContext返回参数结构体
  */
@@ -3769,6 +3908,21 @@ export interface ApplyConfigToMachineGroupResponse {
   RequestId?: string
 }
 
+/**
+ * 告警通知渠道组详情
+ */
+export interface AlertHistoryNotice {
+  /**
+   * 通知渠道组名称
+   */
+  Name: string
+
+  /**
+   * 通知渠道组ID
+   */
+  AlarmNoticeId: string
+}
+
 /**
  * DeleteAlarm请求参数结构体
  */
@@ -3913,6 +4067,26 @@ export interface CreateCosRechargeResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeAlertRecordHistory返回参数结构体
+ */
+export interface DescribeAlertRecordHistoryResponse {
+  /**
+   * 告警历史总数
+   */
+  TotalCount?: number
+
+  /**
+   * 告警历史详情
+   */
+  Records?: Array<AlertHistoryRecord>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 键值或者元字段索引的字段信息
  */

package/src/services/cwp/v20180228/cwp_client.ts

@@ -830,8 +830,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 导出ES查询文档列表
-   */
+     * 旧版日志下载接口下线
+
+导出ES查询文档列表
+     */
   async DescribeSearchExportList(
     req: DescribeSearchExportListRequest,
     cb?: (error: string, rep: DescribeSearchExportListResponse) => void