tencentcloud-sdk-nodejs 4.1.97 → 4.1.98

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

@@ -217,11 +217,14 @@ export interface DescribeLogHistogramRequest {
      */
     To: number;
     /**
-     * 查询语句
+     * 检索分析语句。
+  语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句。
+  使用*或空字符串可查询所有日志。
      */
     Query: string;
     /**
      * 要查询的日志主题ID
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId?: string;
     /**
@@ -240,11 +243,11 @@ export interface DescribeLogHistogramRequest {
  */
 export interface DeleteAlarmShieldRequest {
     /**
-     * 屏蔽规则id。
+     * 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
      */
     TaskId: string;
     /**
-     * 通知渠道组id。
+     * 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
      */
     AlarmNoticeId: string;
 }
@@ -313,11 +316,11 @@ export interface DeleteShipperRequest {
  */
 export interface DeleteScheduledSqlRequest {
     /**
-     * 任务ID
+     * 任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
      */
     TaskId: string;
     /**
-     * 源日志主题ID
+     * 源日志主题ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
      */
     SrcTopicId: string;
 }
@@ -397,11 +400,17 @@ export interface DescribeShipperTasksResponse {
  */
 export interface CheckFunctionRequest {
     /**
-     * 用户输入的加工语句
+     * 加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
+  
+  其他参考文档：
+  
+  - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
+  -  [函数总览](https://cloud.tencent.com/document/product/614/70395)
      */
     EtlContent: string;
     /**
-     * 加工任务目的topic_id以及别名
+     * 加工任务目标topic_id以及别名，当 FuncType 为 1 时，必填。
+  目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     DstResources?: Array<DataTransformResouceInfo>;
     /**
@@ -591,7 +600,9 @@ export interface ConsoleSharingConfig {
  */
 export interface DeleteConsoleSharingRequest {
     /**
-     * 免密分享Id
+     * 免密分享Id。
+  - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
+  - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
      */
     SharingId: string;
 }
@@ -790,6 +801,7 @@ export interface DeleteNoticeContentResponse {
 export interface DeleteTopicRequest {
     /**
      * 日志主题ID
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
 }
@@ -798,7 +810,8 @@ export interface DeleteTopicRequest {
  */
 export interface DescribePartitionsRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
 }
@@ -891,10 +904,12 @@ export interface ConfigInfo {
     Output?: string;
     /**
      * 更新时间
+  - 时间格式：yyyy-MM-dd HH:mm:ss
      */
     UpdateTime?: string;
     /**
      * 创建时间
+  - 时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
@@ -919,10 +934,12 @@ export interface ConfigInfo {
 export interface QueryRangeMetricRequest {
     /**
      * 指标主题ID
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
      * 查询语句，使用PromQL语法
+  - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
      */
     Query: string;
     /**
@@ -1002,7 +1019,7 @@ export interface DeleteCloudProductLogCollectionRequest {
      */
     LogType: string;
     /**
-     * 云产品地域。 不同日志类型(LogType)地域入參格式存在差异， 请参考如下示例：
+     * 云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例：
   - CDS所有日志类型：ap-guangzhou
   - CDB-AUDIT: gz
   - TDSQL-C-AUDIT: gz
@@ -1024,6 +1041,7 @@ export interface DeleteCloudProductLogCollectionRequest {
 export interface CreateCloudProductLogCollectionRequest {
     /**
      * 实例ID
+  - 通过各个接入云产品官方文档获取
      */
     InstanceId: string;
     /**
@@ -1035,7 +1053,7 @@ export interface CreateCloudProductLogCollectionRequest {
      */
     LogType: string;
     /**
-     * 云产品地域。 不同日志类型(LogType)地域入參格式存在差异， 请参考如下示例：
+     * 云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例：
   - CDS所有日志类型：ap-guangzhou
   - CDB-AUDIT: gz
   - TDSQL-C-AUDIT:  gz
@@ -1052,6 +1070,7 @@ export interface CreateCloudProductLogCollectionRequest {
     CloudProductRegion: string;
     /**
      * CLS目标地域
+  - 支持地域参考  [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
      */
     ClsRegion: string;
     /**
@@ -1063,15 +1082,17 @@ export interface CreateCloudProductLogCollectionRequest {
      */
     TopicName?: string;
     /**
-     * 日志配置拓展信息， 一般用于存储额外的日志投递配置
+     * 日志配置扩展信息， 一般用于存储额外的日志投递配置
      */
     Extend?: string;
     /**
      * 日志集id
+  - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
      */
     LogsetId?: string;
     /**
      * 日志主题id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId?: string;
 }
@@ -1469,11 +1490,11 @@ export interface AlarmClassification {
  */
 export interface ScheduledSqlResouceInfo {
     /**
-     * 目标主题id
+     * 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
      */
     TopicId: string;
     /**
-     * 主题的地域信息
+     * 主题的地域信息，当前不支持跨地域，支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
      */
     Region?: string;
     /**
@@ -1587,6 +1608,7 @@ export interface MachineGroupInfo {
     MachineGroupType?: MachineGroupTypeInfo;
     /**
      * 创建时间
+  时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
@@ -1599,10 +1621,12 @@ export interface MachineGroupInfo {
     AutoUpdate?: string;
     /**
      * 升级开始时间，建议业务低峰期升级LogListener
+  时间格式：HH:mm:ss
      */
     UpdateStartTime?: string;
     /**
      * 升级结束时间，建议业务低峰期升级LogListener
+  时间格式：HH:mm:ss
      */
     UpdateEndTime?: string;
     /**
@@ -1610,7 +1634,7 @@ export interface MachineGroupInfo {
      */
     ServiceLogging?: boolean;
     /**
-     * 机器组中机器离线定期清理时间
+     * 机器组中机器离线定期清理时间，单位天，默认设置30天。
      */
     DelayCleanupTime?: number;
     /**
@@ -1627,7 +1651,8 @@ export interface MachineGroupInfo {
  */
 export interface DeleteMachineGroupInfoRequest {
     /**
-     * 机器组ID
+     * 机器组Id
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
      */
     GroupId: string;
     /**
@@ -1751,7 +1776,9 @@ export interface DashboardNoticeMode {
   <li/>Uin：腾讯云用户<br>
   <li/>Group：腾讯云用户组<br>
   <li/>Email：自定义Email<br>
-  <li/>WeCom: 企业微信回调
+  <li/>WeCom: 企业微信回调<br>
+  <li/>DingTalk：钉钉<br>
+  <li/>Lark：飞书
      */
     ReceiverType: string;
     /**
@@ -1779,12 +1806,24 @@ export interface DashboardNoticeMode {
 export interface KafkaProtocolInfo {
     /**
      * 协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。
-  入参必填
+  
+  - 当IsEncryptionAddr为true时，Protocol必填。
+  - 支持的协议类型如下：
+      - plaintext：纯文本无加密协议
+      - sasl_ssl：SASL 认证 + SSL 加密
+      - ssl：纯 SSL/TLS 加密协议
+      - sasl_plaintext：SASL 认证 + 非加密通道
+  
      */
     Protocol?: string;
     /**
      * 加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
-  当Protocol为sasl_plaintext或sasl_ssl时必填
+  
+  - 当Protocol为  `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
+  - 支持加密类型如下
+      -  PLAIN：明文认证
+      -  SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法
+      -  SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法
      */
     Mechanism?: string;
     /**
@@ -1823,11 +1862,11 @@ export interface ScheduledSqlTaskInfo {
      */
     DstResource?: ScheduledSqlResouceInfo;
     /**
-     * 任务创建时间
+     * 任务创建时间。格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
-     * 任务更新时间
+     * 任务更新时间，格式：yyyy-MM-dd HH:mm:ss
      */
     UpdateTime?: string;
     /**
@@ -1845,7 +1884,7 @@ export interface ScheduledSqlTaskInfo {
      */
     ScheduledSqlContent?: string;
     /**
-     * 调度开始时间
+     * 调度开始时间，格式：yyyy-MM-dd HH:mm:ss
      */
     ProcessStartTime?: string;
     /**
@@ -1853,11 +1892,11 @@ export interface ScheduledSqlTaskInfo {
      */
     ProcessType?: number;
     /**
-     * 调度结束时间，当process_type=2时为必传字段
+     * 调度结束时间，格式：yyyy-MM-dd HH:mm:ss，当process_type=2时为必传字段
      */
     ProcessEndTime?: string;
     /**
-     * 调度周期(分钟)
+     * 调度周期(分钟)，1~1440分钟
      */
     ProcessPeriod?: number;
     /**
@@ -1865,11 +1904,11 @@ export interface ScheduledSqlTaskInfo {
      */
     ProcessTimeWindow?: string;
     /**
-     * 执行延迟(秒)
+     * 执行延迟(秒)，0~120秒，默认60秒
      */
     ProcessDelay?: number;
     /**
-     * 源topicId的地域信息
+     * 源topicId的地域信息，支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
      */
     SrcTopicRegion?: string;
     /**
@@ -1891,6 +1930,7 @@ export interface ScheduledSqlTaskInfo {
 export interface DescribeConfigMachineGroupsRequest {
     /**
      * 采集配置ID
+  - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
      */
     ConfigId: string;
 }
@@ -1913,10 +1953,15 @@ export interface MetaTagInfo {
 export interface ModifyTopicRequest {
     /**
      * 日志主题ID
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
      * 日志主题名称
+  输入限制：
+  - 不能为空字符串
+  - 不能包含字符'|'
+  - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
      */
     TopicName?: string;
     /**
@@ -1933,7 +1978,8 @@ export interface ModifyTopicRequest {
      */
     AutoSplit?: boolean;
     /**
-     * 若开启最大分裂，该主题能够能够允许的最大分区数
+     * 若开启最大分裂，该主题能够能够允许的最大分区数；
+  默认为50；必须为正数
      */
     MaxSplitPartitions?: number;
     /**
@@ -1959,11 +2005,17 @@ export interface ModifyTopicRequest {
      */
     Extends?: TopicExtendInfo;
     /**
-     * 日志主题分区数量
+     * 日志主题分区数量。
+  默认为1；
+  取值范围及约束：
+  - 当输入值<=0，系统自动调整为1。
+  - 如果未传MaxSplitPartitions，需要PartitionCount<=50；
+  - 如果传递了MaxSplitPartitions，需要PartitionCount<=MaxSplitPartitions；
      */
     PartitionCount?: number;
     /**
      * 取消切换存储任务的id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
      */
     CancelTopicAsyncTaskID?: string;
 }
@@ -2094,7 +2146,9 @@ export interface DeleteConfigExtraResponse {
  */
 export interface ModifyConsumerRequest {
     /**
-     * 投递任务绑定的日志主题 ID
+     * 投递任务绑定的日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -2189,6 +2243,10 @@ export interface DescribeConsoleSharingListResponse {
      * 分页的总数目
      */
     TotalCount?: number;
+    /**
+     * 控制台免密分享列表
+     */
+    ConsoleSharingInfos?: Array<ConsoleSharingInfo>;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -2231,14 +2289,25 @@ export interface DataTransformResouceInfo {
 export interface CreateDashboardSubscribeRequest {
     /**
      * 仪表盘订阅名称。
+  输入限制：
+  - 不能为空
+  - 长度不能超过128字节
+  - 不能包含字符'|'
      */
     Name: string;
     /**
-     * 仪表盘id。
+     * 仪表盘Id。
+  - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
      */
     DashboardId: string;
     /**
-     * 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。<br><li/>{秒数} 取值范围： 0 ~ 59 <br><li/>{分钟} 取值范围： 0 ~ 59  <br><li/>{小时} 取值范围： 0 ~ 23  <br><li/>{日期} 取值范围： 1 ~ 31 AND (dayOfMonth最后一天： L) <br><li/>{月份} 取值范围： 1 ~ 12 <br><li/>{星期} 取值范围： 0 ~ 6 【0:星期日， 6星期六】
+     * 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。
+  - {秒数} 取值范围： 0 ~ 59
+  - {分钟} 取值范围： 0 ~ 59
+  - {小时} 取值范围： 0 ~ 23
+  - {日期} 取值范围： 1 ~ 31 AND (dayOfMonth最后一天： L)
+  - {月份} 取值范围： 1 ~ 12
+  - {星期} 取值范围： 0 ~ 6 【0:星期日， 6星期六】
      */
     Cron: string;
     /**
@@ -2251,7 +2320,8 @@ export interface CreateDashboardSubscribeRequest {
  */
 export interface DeleteMachineGroupRequest {
     /**
-     * 机器组ID
+     * 机器组Id
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
      */
     GroupId: string;
 }
@@ -2279,7 +2349,11 @@ export interface FullTextInfo {
  */
 export interface QueryMetricResponse {
     /**
-     * 指标查询结果类型
+     * 指标查询结果类型，支持
+  - scalar 标量值
+  - string 字符串值
+  - vector 瞬时向量
+  - matrix 区间向量
      */
     ResultType?: string;
     /**
@@ -2655,11 +2729,14 @@ export interface EventLog {
      */
     EventChannel: string;
     /**
-     * 时间类型，1:用户自定义，2:当前时间
+     * 时间字段（Timestamp）支持的类型
+  - 1（用户自定义时间）
+  - 2（当前时间）
      */
     TimeType: number;
     /**
      * 时间，用户选择自定义时间类型时，需要指定时间，单位秒
+  格式：时间戳，1754897446
      */
     Timestamp?: number;
     /**
@@ -2780,7 +2857,7 @@ export interface CreateAlarmRequest {
  */
 export interface DeleteDataTransformRequest {
     /**
-     * 数据加工任务id
+     * 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
      */
     TaskId: string;
 }
@@ -2862,10 +2939,12 @@ export interface PartitionInfo {
     ExclusiveEndKey?: string;
     /**
      * 分区创建时间
+  时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
      * 只读分区数据停止写入时间
+  时间格式：yyyy-MM-dd HH:mm:ss
   注意：此字段可能返回 null，表示取不到有效值。
      */
     LastWriteTime?: string;
@@ -3109,7 +3188,10 @@ export interface ConfigExtraInfo {
      */
     TopicId?: string;
     /**
-     * 类型：container_stdout、container_file、host_file
+     * 自建k8s集群日志采集类型，支持
+  - container_stdout 标准输出
+  - container_file 标准文件
+  - host_file 节点文件
      */
     Type?: string;
     /**
@@ -3143,10 +3225,12 @@ export interface ConfigExtraInfo {
     ExcludePaths?: Array<ExcludePathInfo>;
     /**
      * 更新时间
+  - 时间格式：yyyy-MM-dd HH:mm:ss
      */
     UpdateTime?: string;
     /**
      * 创建时间
+  - 时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
@@ -3155,6 +3239,7 @@ export interface ConfigExtraInfo {
     UserDefineRule?: string;
     /**
      * 机器组ID
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
      */
     GroupId?: string;
     /**
@@ -3163,6 +3248,7 @@ export interface ConfigExtraInfo {
     ConfigFlag?: string;
     /**
      * 日志集ID
+  - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
      */
     LogsetId?: string;
     /**
@@ -3349,7 +3435,9 @@ export interface DeleteAlarmShieldResponse {
  */
 export interface DescribeConsumerRequest {
     /**
-     * 投递任务绑定的日志主题 ID
+     * 投递任务绑定的日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
 }
@@ -3407,10 +3495,16 @@ export interface DescribeLogsetsResponse {
 export interface CreateTopicRequest {
     /**
      * 日志集ID
+  - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
      */
     LogsetId: string;
     /**
      * 日志主题名称
+  名称限制
+  - 不能为空字符串
+  - 不能包含字符'|'
+  - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
+  
      */
     TopicName: string;
     /**
@@ -3473,7 +3567,7 @@ export interface DescribeTopicsRequest {
      * <ul><li>topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否</li>
   <li>logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否</li>
   <li>topicId 按照【日志主题ID】进行过滤。类型：String。必选：否</li>
-  <li>logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否</li>
+  <li>logsetId 按照【日志集ID】进行过滤，可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看；也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型：String。必选：否</li>
   <li>tagKey 按照【标签键】进行过滤。类型：String。必选：否</li>
   <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否</li>
   <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否</li></ul>
@@ -3589,7 +3683,8 @@ export interface CreateDashboardSubscribeResponse {
  */
 export interface DescribeExportsRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -3694,11 +3789,11 @@ export interface CreateKafkaRechargeResponse {
  */
 export interface ModifyScheduledSqlRequest {
     /**
-     * 任务ID
+     * 任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
      */
     TaskId: string;
     /**
-     * 源日志主题
+     * 源日志主题，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
      */
     SrcTopicId?: string;
     /**
@@ -3714,7 +3809,7 @@ export interface ModifyScheduledSqlRequest {
      */
     ScheduledSqlContent?: string;
     /**
-     * 调度周期(分钟)
+     * 调度周期(分钟)，1~1440分钟
      */
     ProcessPeriod?: number;
     /**
@@ -3722,15 +3817,15 @@ export interface ModifyScheduledSqlRequest {
      */
     ProcessTimeWindow?: string;
     /**
-     * 执行延迟(秒)
+     * 执行延迟(秒)，0~120秒，默认60秒
      */
     ProcessDelay?: number;
     /**
-     * 源topicId的地域信息
+     * 源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
      */
     SrcTopicRegion?: string;
     /**
-     * 任务名称
+     * 任务名称，0~255字符
      */
     Name?: string;
     /**
@@ -3787,27 +3882,32 @@ export interface ModifyAlarmShieldResponse {
  */
 export interface CreateDeliverCloudFunctionRequest {
     /**
-     * 投递规则属于的 topic id
+     * 投递规则属于的TopicId。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
     /**
      * 投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) （[函数类型选型](https://cloud.tencent.com/document/product/583/73483)）
+  通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
      */
     FunctionName: string;
     /**
-     * 命名空间
+     * 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
+  - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
      */
     Namespace: string;
     /**
-     * 函数版本
+     * 函数版本。
+  - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
      */
     Qualifier: string;
     /**
-     * 投递最长等待时间，单位：秒
+     * 投递最长等待时间，单位：秒。 默认：60
      */
     Timeout?: number;
     /**
-     * 投递最大消息数
+     * 投递最大消息数。默认为100。支持范围[1,10000]
      */
     MaxMsgNum?: number;
 }
@@ -3825,7 +3925,9 @@ export interface ModifyCloudProductLogCollectionResponse {
  */
 export interface DeleteConsumerRequest {
     /**
-     * 投递任务绑定的日志主题 ID
+     * 投递任务绑定的日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
 }
@@ -3835,7 +3937,7 @@ export interface DeleteConsumerRequest {
 export interface NoticeContentInfo {
     /**
      * 通知内容模板标题信息。
-  部分通知渠道类型不支持“标题”，请参照腾讯云控制台页面。
+  部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
      */
     Title?: string;
     /**
@@ -3882,7 +3984,8 @@ export interface CreateWebCallbackRequest {
  */
 export interface DescribeMachineGroupsRequest {
     /**
-     * machineGroupName
+     * 过滤条件
+  machineGroupName
   - 按照【机器组名称】进行过滤。
   - 类型：String
   - 必选：否
@@ -3893,7 +3996,7 @@ export interface DescribeMachineGroupsRequest {
   - 必选：否
   
   osType
-  - 按照【操作系统类型】进行过滤。
+  - 按照【操作系统类型】进行过滤。0： Linux；1： Windows
   - 类型：Int
   - 必选：否
   
@@ -3947,11 +4050,12 @@ export interface AnonymousInfo {
  */
 export interface ExtractRuleInfo {
     /**
-     * 时间字段的key名字，TikeKey和TimeFormat必须成对出现
+     * 时间字段的key名字，TimeKey和TimeFormat必须成对出现
      */
     TimeKey?: string;
     /**
      * 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数
+  - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
      */
     TimeFormat?: string;
     /**
@@ -4118,16 +4222,20 @@ export interface DescribeConfigsRequest {
   - 按照【采集配置名称】进行模糊匹配过滤。
   - 类型：String
   - 必选：否
+  - 示例：test-config
   
   configId
   - 按照【采集配置ID】进行过滤。
   - 类型：String
   - 必选：否
+  - 示例：3581a3be-aa41-423b-995a-54ec84da6264
   
   topicId
   - 按照【日志主题】进行过滤。
   - 类型：String
   - 必选：否
+  - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
   
   每次请求的Filters的上限为10，Filter.Values的上限为5。
      */
@@ -4261,7 +4369,8 @@ export interface DashboardTopicInfo {
  */
 export interface DeleteConfigRequest {
     /**
-     * 采集规则配置ID
+     * 采集配置ID
+   - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
      */
     ConfigId: string;
 }
@@ -4348,7 +4457,7 @@ export interface LogRechargeRuleInfo {
      */
     EncodingFormat: number;
     /**
-     * 使用默认时间，true：开启（默认值）， flase：关闭
+     * 使用默认时间状态。true：开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳；false：关闭将使用日志中的时间字段作为日志时间戳。 默认：true
      */
     DefaultTimeSwitch: boolean;
     /**
@@ -4372,19 +4481,107 @@ export interface LogRechargeRuleInfo {
      */
     DefaultTimeSrc?: number;
     /**
-     * 时间字段
+     * 时间字段，日志中代表时间的字段名。
+  
+  - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时， TimeKey不能为空。
      */
     TimeKey?: string;
     /**
-     * 时间提取正则表达式
+     * 时间提取正则表达式。
+  - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时， TimeRegex不能为空。
+  - 仅需输入日志中代表时间的字段的正则表达式即可；若匹配到多个字段，将使用第一个。
+     例：日志原文为：message with time 2022-08-08 14:20:20，则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
+  
      */
     TimeRegex?: string;
     /**
-     * 时间字段格式
+     * 时间字段格式。
+  - 当DefaultTimeSwitch为false时， TimeFormat不能为空。
      */
     TimeFormat?: string;
     /**
-     * 时间字段时区
+     * 时间字段时区。
+  - 当DefaultTimeSwitch为false时， TimeZone不能为空。
+  - 时区格式规则
+   ​前缀​：使用 GMT 或 UTC 作为时区基准
+   ​偏移量​：
+      - `-` 表示西时区（比基准时间晚）
+      - `+` 表示东时区（比基准时间早）
+      -  格式为 ±HH:MM（小时:分钟）
+  
+  - 当前支持：
+  ```
+  "GMT-12:00"
+  "GMT-11:00"
+  "GMT-10:00"
+  "GMT-09:30"
+  "GMT-09:00"
+  "GMT-08:00"
+  "GMT-07:00"
+  "GMT-06:00"
+  "GMT-05:00"
+  "GMT-04:00"
+  "GMT-03:30"
+  "GMT-03:00"
+  "GMT-02:00"
+  "GMT-01:00"
+  "GMT+00:00"
+  "GMT+01:00"
+  "GMT+02:00"
+  "GMT+03:30"
+  "GMT+04:00"
+  "GMT+04:30"
+  "GMT+05:00"
+  "GMT+05:30"
+  "GMT+05:45"
+  "GMT+06:00"
+  "GMT+06:30"
+  "GMT+07:00"
+  "GMT+08:00"
+  "GMT+09:00"
+  "GMT+09:30"
+  "GMT+10:00"
+  "GMT+10:30"
+  "GMT+11:00"
+  "GMT+11:30"
+  "GMT+12:00"
+  "GMT+12:45"
+  "GMT+13:00"
+  "GMT+14:00"
+  "UTC-11:00"
+  "UTC-10:00"
+  "UTC-09:00"
+  "UTC-08:00"
+  "UTC-12:00"
+  "UTC-07:00"
+  "UTC-06:00"
+  "UTC-05:00"
+  "UTC-04:30"
+  "UTC-04:00"
+  "UTC-03:30"
+  "UTC-03:00"
+  "UTC-02:00"
+  "UTC-01:00"
+  "UTC+00:00"
+  "UTC+01:00"
+  "UTC+02:00"
+  "UTC+03:00"
+  "UTC+03:30"
+  "UTC+04:00"
+  "UTC+04:30"
+  "UTC+05:00"
+  "UTC+05:45"
+  "UTC+06:00"
+  "UTC+06:30"
+  "UTC+07:00"
+  "UTC+08:00"
+  "UTC+09:00"
+  "UTC+09:30"
+  "UTC+10:00"
+  "UTC+11:00"
+  "UTC+12:00"
+  "UTC+13:00"
+  ```
      */
     TimeZone?: string;
     /**
@@ -4465,7 +4662,9 @@ export interface ShipperTaskInfo {
  */
 export interface CloseKafkaConsumerRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     FromTopicId: string;
 }
@@ -4487,7 +4686,8 @@ export interface RuleTagInfo {
  */
 export interface CreateExportRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -4627,6 +4827,7 @@ export interface DescribeMachineGroupsResponse {
 export interface DeleteConfigExtraRequest {
     /**
      * 特殊采集规则扩展配置ID
+  - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
      */
     ConfigExtraId: string;
 }
@@ -4689,6 +4890,8 @@ export interface ModifyConfigRequest {
     ConfigId: string;
     /**
      * 采集规则配置名称
+  - 不能包含特殊字符｜
+  - 长度不能超过255字符，超过会被截断
      */
     Name?: string;
     /**
@@ -4720,6 +4923,7 @@ export interface ModifyConfigRequest {
     ExcludePaths?: Array<ExcludePathInfo>;
     /**
      * 采集配置关联的日志主题（TopicId）
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     Output?: string;
     /**
@@ -4755,15 +4959,18 @@ export interface AddMachineGroupInfoRequest {
  */
 export interface DescribeKafkaRechargesRequest {
     /**
-     * 日志主题 ID
+     * 日志主题Id。
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
-     * 导入配置ID
+     * 导入配置Id。
+  - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
+  - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
      */
     Id?: string;
     /**
-     * 状态   status 1: 运行中, 2: 暂停...
+     * 状态。1: 运行中，2: 暂停，3：错误
      */
     Status?: number;
 }
@@ -4795,7 +5002,9 @@ export interface JsonInfo {
  */
 export interface ModifyConsoleSharingRequest {
     /**
-     * 免密分享链接Id
+     * 免密分享Id。
+  - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
+  - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
      */
     SharingId: string;
     /**
@@ -5066,10 +5275,13 @@ export interface DeleteConsoleSharingResponse {
 export interface CreateConfigRequest {
     /**
      * 采集配置名称
+  - 名称种不得包含特殊字符｜
+  - 名称最长255字符，超过截断
      */
     Name: string;
     /**
      * 采集配置所属日志主题ID即TopicId
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     Output: string;
     /**
@@ -5440,6 +5652,53 @@ export interface ValueInfo {
      */
     Alias?: string;
 }
+/**
+ * 控制台分享信息
+ */
+export interface ConsoleSharingInfo {
+    /**
+     * 分享ID
+     */
+    SharingId: string;
+    /**
+     * 分享链接
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    SharingUrl?: string;
+    /**
+     * 匿名分享配置信息
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    SharingConfig?: ConsoleSharingConfig;
+    /**
+     * 过期时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ExpiredTime?: number;
+    /**
+     * 创建时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    CreateTime?: number;
+    /**
+     * 修改时间
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    UpdateTime?: number;
+    /**
+     * 分享链接状态
+  1: 正常
+  -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Status?: number;
+    /**
+     * 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐（天御独有恶意类型），20472-违法，
+  24005-社会
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ContentSafetyCode?: number;
+}
 /**
  * DescribeDataTransformInfo请求参数结构体
  */
@@ -5515,11 +5774,13 @@ export interface DeleteShipperResponse {
  */
 export interface ModifyKafkaConsumerRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     FromTopicId: string;
     /**
-     * 压缩方式[0:NONE；2:SNAPPY；3:LZ4]
+     * 压缩方式。0：不压缩；2：使用Snappy压缩；3：使用LZ4压缩
      */
     Compression?: number;
     /**
@@ -5581,11 +5842,11 @@ export interface ExportInfo {
      */
     Status?: string;
     /**
-     * 日志导出起始时间
+     * 日志导出起始时间，毫秒时间戳
      */
     From?: number;
     /**
-     * 日志导出结束时间
+     * 日志导出结束时间，毫秒时间戳
      */
     To?: number;
     /**
@@ -5594,6 +5855,7 @@ export interface ExportInfo {
     CosPath?: string;
     /**
      * 日志导出创建时间
+  时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
@@ -5645,6 +5907,7 @@ export interface TopicInfo {
     AssumerName?: string;
     /**
      * 创建时间
+  时间格式：yyyy-MM-dd HH:mm:ss
      */
     CreateTime?: string;
     /**
@@ -5711,10 +5974,15 @@ export interface TopicInfo {
     TopicAsyncTaskID?: string;
     /**
      * 异步迁移状态
+  - 1：进行中
+  - 2：已完成
+  - 3：失败
+  - 4：已取消
      */
     MigrationStatus?: number;
     /**
      * 异步迁移完成后，预计生效日期
+  时间格式：yyyy-MM-dd HH:mm:ss
      */
     EffectiveDate?: string;
 }
@@ -5855,7 +6123,9 @@ export interface CheckFunctionResponse {
  */
 export interface DeleteExportRequest {
     /**
-     * 日志导出ID
+     * 日志导出任务Id
+  - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
+  
      */
     ExportId: string;
 }
@@ -6105,7 +6375,9 @@ export interface NoticeReceiver {
  */
 export interface CreateKafkaRechargeRequest {
     /**
-     * 导入CLS目标topic ID
+     * 导入CLS目标TopicId。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -6130,6 +6402,7 @@ export interface CreateKafkaRechargeRequest {
     LogRechargeRule: LogRechargeRuleInfo;
     /**
      * 腾讯云CKafka实例ID，KafkaType为0时必填。
+  - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
      */
     KafkaInstance?: string;
     /**
@@ -6146,7 +6419,8 @@ export interface CreateKafkaRechargeRequest {
      */
     Protocol?: KafkaProtocolInfo;
     /**
-     * 用户Kafka消费组名称
+     * 用户Kafka消费组名称。
+  - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制，一个消费组中存在多个消费者，组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition，但一个 Partition 只能被消费组内的一个消费者消费。
      */
     ConsumerGroupName?: string;
 }
@@ -6211,7 +6485,9 @@ export interface CreateConfigResponse {
  */
 export interface CreateConsumerRequest {
     /**
-     * 投递任务绑定的日志主题 ID
+     * 投递任务绑定的日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -6337,7 +6613,9 @@ export interface ModifyNoticeContentRequest {
  */
 export interface OpenKafkaConsumerRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     FromTopicId: string;
     /**
@@ -6354,7 +6632,11 @@ export interface OpenKafkaConsumerRequest {
  */
 export interface QueryRangeMetricResponse {
     /**
-     * 指标查询结果类型
+     * 指标查询结果类型，支持
+  - scalar 标量值
+  - string 字符串值
+  - vector 瞬时向量
+  - matrix 区间向量
      */
     ResultType?: string;
     /**
@@ -6612,11 +6894,11 @@ export interface AlarmShieldInfo {
      */
     Status?: number;
     /**
-     * 规则创建时间。
+     * 规则创建时间。秒级时间戳(s)
      */
     CreateTime?: number;
     /**
-     * 规则更新时间。
+     * 规则更新时间。秒级时间戳(s)
      */
     UpdateTime?: number;
 }
@@ -6690,10 +6972,12 @@ export interface CreateCloudProductLogCollectionResponse {
 export interface DeleteConfigFromMachineGroupRequest {
     /**
      * 机器组ID
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
      */
     GroupId: string;
     /**
      * 采集配置ID
+   - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
      */
     ConfigId: string;
 }
@@ -6779,10 +7063,12 @@ export interface DescribeAlarmsRequest {
 export interface QueryMetricRequest {
     /**
      * 查询语句，使用PromQL语法
+  - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
      */
     Query: string;
     /**
      * 指标主题ID
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -6971,11 +7257,15 @@ export interface AddMachineGroupInfoResponse {
  */
 export interface ModifyMachineGroupRequest {
     /**
-     * 机器组ID
+     * 机器组Id
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
      */
     GroupId: string;
     /**
      * 机器组名称
+  输入限制：
+  - 不能为空字符串
+  - 不能包含字符'|'
      */
     GroupName?: string;
     /**
@@ -6994,10 +7284,12 @@ export interface ModifyMachineGroupRequest {
     AutoUpdate?: boolean;
     /**
      * 升级开始时间，建议业务低峰期升级LogListener
+  时间格式：HH:mm:ss
      */
     UpdateStartTime?: string;
     /**
      * 升级结束时间，建议业务低峰期升级LogListener
+  时间格式：HH:mm:ss
      */
     UpdateEndTime?: string;
     /**
@@ -7033,11 +7325,12 @@ export interface MachineGroupTypeInfo {
  */
 export interface MergePartitionRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
-     * 合并的PartitionId（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等，且找到的分区必须是读写分区（Staus:readwrite），入参PartitionId与找到的PartitionId设置为只读分区（Status:readonly）,再新建一个新的读写分区） 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
+     * 合并的PartitionId（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等，且找到的分区必须是读写分区（Status:readwrite），入参PartitionId与找到的PartitionId设置为只读分区（Status:readonly）,再新建一个新的读写分区） 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
   
   1. 入参PartitionId只能是读写分区（Status的值有readonly，readwrite），且能找到入参PartitionId的下一个可读写分区（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等）；
   2. 入参PartitionId不能是最后一个分区（PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff）；
@@ -7119,27 +7412,41 @@ export interface CreateNoticeContentRequest {
  */
 export interface Ckafka {
     /**
-     * Ckafka 的 InstanceId
+     * Ckafka 的 InstanceId。
+  - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
+  - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
      */
     InstanceId: string;
     /**
-     * Ckafka 的 TopicName
+     * Ckafka 的 TopicName。
+  - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
+  - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
      */
     TopicName: string;
     /**
-     * Ckafka 的 Vip
+     * Ckafka 的 Vip。
+  - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
+  - 如果是通过 角色ARN 方式创建投递任务，则Vip字段可为空。
      */
     Vip?: string;
     /**
-     * Ckafka 的 Vport
+     * Ckafka 的 Vport。
+  - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
+  - 如果是通过 角色ARN 方式创建投递任务，则Vport字段可为空。
      */
     Vport?: string;
     /**
-     * Ckafka 的 InstanceName
+     * Ckafka 的 InstanceName。
+  - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
+  - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
+  - 如果是通过 角色ARN 方式创建投递任务，则InstanceName字段可为空。
      */
     InstanceName?: string;
     /**
-     * Ckafka 的 TopicId
+     * Ckafka 的 TopicId。
+  - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
+  - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
+  - 如果是通过 角色ARN 方式创建投递任务，则TopicId字段可为空。
      */
     TopicId?: string;
 }
@@ -7238,15 +7545,14 @@ export interface DescribeScheduledSqlInfoRequest {
      */
     TaskId?: string;
     /**
-     * <li>srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否</li>
-  <li>dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否</li>
-  <li>srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否</li>
-  <li>dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否</li>
-  <li>bizType按照【主题类型】进行过滤，0：日志主题；1：指标主题。类型：String。必选：否</li>
-  <li>status按照【任务状态】进行过滤，1：运行；2：停止。类型：String。必选：否</li>
-  <li>taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否</li>
-  <li>taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否</li>
-  
+     * - srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题1 ，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
+  - dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题 2，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
+  - srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否。示例：a4478687-2382-4486-9692-de7986350f6b ，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
+  - dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否。示例：bd4d3375-d72a-4cd2-988d-d8eda2bd62b0，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
+  - bizType按照【主题类型】进行过滤，0：日志主题；1：指标主题。类型：String。必选：否
+  - status按照【任务状态】进行过滤，1：运行；2：停止；3：异常。类型：String。必选：否
+  - taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否。示例：metricTask ，通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
+  - taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否。示例：9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ，通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
      */
     Filters?: Array<Filter>;
 }
@@ -7442,11 +7748,11 @@ export interface DescribeExportsResponse {
     /**
      * 日志导出列表
      */
-    Exports: Array<ExportInfo>;
+    Exports?: Array<ExportInfo>;
     /**
      * 总数目
      */
-    TotalCount: number;
+    TotalCount?: number;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -7458,10 +7764,12 @@ export interface DescribeExportsResponse {
 export interface ApplyConfigToMachineGroupRequest {
     /**
      * 采集配置ID
+   - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
      */
     ConfigId: string;
     /**
      * 机器组ID
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
      */
     GroupId: string;
 }
@@ -7561,18 +7869,22 @@ export interface DescribeConfigExtrasRequest {
   name
   - 按照【特殊采集配置名称】进行模糊匹配过滤。
   - 类型：String
+  - 示例：test-config
   
   configExtraId
   - 按照【特殊采集配置ID】进行过滤。
   - 类型：String
+  - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
   
   topicId
   - 按照【日志主题】进行过滤。
   - 类型：String
+  - 示例：3581a3be-aa41-423b-995a-54ec84da6264
   
   machineGroupId
   - 按照【机器组ID】进行过滤。
   - 类型：String
+  - 示例：f948972f-a063-408c-a59f-8c3230bddaf6
   
   每次请求的Filters的上限为10，Filter.Values的上限为5。
      */
@@ -7729,11 +8041,11 @@ export interface HistogramInfo {
     /**
      * 统计周期内的日志条数
      */
-    Count: number;
+    Count?: number;
     /**
      * 按 period 取整后的 unix timestamp： 单位毫秒
      */
-    BTime: number;
+    BTime?: number;
 }
 /**
  * DescribeMachineGroupConfigs请求参数结构体
@@ -7741,6 +8053,7 @@ export interface HistogramInfo {
 export interface DescribeMachineGroupConfigsRequest {
     /**
      * 机器组ID
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
      */
     GroupId: string;
 }
@@ -7853,11 +8166,15 @@ export interface ModifyConfigExtraRequest {
  */
 export interface ModifyKafkaRechargeRequest {
     /**
-     * Kafka导入配置ID
+     * 导入配置Id。
+  - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
+  - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
      */
     Id: string;
     /**
-     * 导入CLS目标topic ID
+     * 导入CLS目标TopicId。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -7870,6 +8187,7 @@ export interface ModifyKafkaRechargeRequest {
     KafkaType?: number;
     /**
      * 腾讯云CKafka实例ID，KafkaType为0时必填。
+  - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
      */
     KafkaInstance?: string;
     /**
@@ -7885,7 +8203,9 @@ export interface ModifyKafkaRechargeRequest {
      */
     Protocol?: KafkaProtocolInfo;
     /**
-     * 用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开
+     * 用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开。
+  
+  - Kafka类型为腾讯云CKafka时：通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
      */
     UserKafkaTopics?: string;
     /**
@@ -7897,7 +8217,7 @@ export interface ModifyKafkaRechargeRequest {
      */
     LogRechargeRule?: LogRechargeRuleInfo;
     /**
-     * 导入控制，1：暂停；2：继续。
+     * 导入控制，1：暂停；2：启动。
      */
     StatusControl?: number;
 }
@@ -8313,7 +8633,9 @@ export interface DeleteNoticeContentRequest {
  */
 export interface DescribeKafkaConsumerRequest {
     /**
-     * 日志主题ID
+     * 日志主题Id。
+  - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
+  - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
      */
     FromTopicId: string;
 }
@@ -8509,7 +8831,9 @@ export interface GetAlarmLogRequest {
     /**
      * 查询过滤条件，例如：
   - 按告警策略ID查询：`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
+     - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
   - 按监控对象ID查询：`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
+    - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
   - 按告警策略ID及监控对象ID查询：`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
   - 按告警策略ID及监控对象ID查询支持SQL语句：`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
      */
@@ -8557,11 +8881,11 @@ export interface MergePartitionResponse {
  */
 export interface CreateScheduledSqlRequest {
     /**
-     * 源日志主题
+     * 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     SrcTopicId: string;
     /**
-     * 任务名称
+     * 任务名称，0~255字符
      */
     Name: string;
     /**
@@ -8585,7 +8909,7 @@ export interface CreateScheduledSqlRequest {
      */
     ProcessType: number;
     /**
-     * 调度周期(分钟)
+     * 调度周期(分钟)，1~1440分钟
      */
     ProcessPeriod: number;
     /**
@@ -8593,11 +8917,11 @@ export interface CreateScheduledSqlRequest {
      */
     ProcessTimeWindow: string;
     /**
-     * 执行延迟(秒)
+     * 执行延迟(秒)，0~120秒，默认60秒
      */
     ProcessDelay: number;
     /**
-     * 源topicId的地域信息
+     * 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
      */
     SrcTopicRegion: string;
     /**