tencentcloud-sdk-nodejs 4.1.98 → 4.1.100

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.
Files changed (50) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/postgres/v20170312/postgres_client.js +6 -15
  3. package/es/services/trocket/v20230308/trocket_client.js +7 -4
  4. package/es/services/vod/v20180717/vod_client.js +12 -0
  5. package/es/services/waf/v20180125/waf_client.js +28 -7
  6. package/package.json +1 -1
  7. package/tencentcloud/common/sdk_version.d.ts +1 -1
  8. package/tencentcloud/common/sdk_version.js +1 -1
  9. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  10. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +5 -5
  11. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +122 -13
  12. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  13. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  14. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +225 -96
  15. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +28 -0
  16. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +16 -0
  17. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +23 -23
  18. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +23 -8
  19. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -1
  20. package/tencentcloud/services/lke/v20231130/lke_client.js +1 -1
  21. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +754 -199
  22. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
  23. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  24. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +18 -0
  25. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +16 -8
  26. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +2 -2
  27. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +8 -26
  28. package/tencentcloud/services/postgres/v20170312/postgres_client.js +10 -34
  29. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +75 -424
  30. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +9 -9
  31. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +21 -7
  32. package/tencentcloud/services/sts/v20180813/sts_client.js +21 -7
  33. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +37 -0
  34. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +12 -0
  35. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -1
  36. package/tencentcloud/services/trabbit/v20230418/trabbit_models.d.ts +20 -0
  37. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +11 -5
  38. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -6
  39. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +93 -0
  40. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +3 -2
  41. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  42. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  43. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +422 -295
  44. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +27 -1
  45. package/tencentcloud/services/vod/v20180717/vod_client.js +34 -0
  46. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +236 -77
  47. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +37 -9
  48. package/tencentcloud/services/waf/v20180125/waf_client.js +54 -12
  49. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +349 -31
  50. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +60 -0
@@ -6,18 +6,22 @@ export interface DescribeAlarmNoticesRequest {
6
6
  * <li> name
7
7
  按照【通知渠道组名称】进行过滤。
8
8
  类型:String
9
+ 示例:"Filters":[{"Key":"name","Values":["test-notice"]}]
9
10
  必选:否</li>
10
11
  <li> alarmNoticeId
11
12
  按照【通知渠道组ID】进行过滤。
12
13
  类型:String
14
+ 示例:"Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]
13
15
  必选:否</li>
14
16
  <li> uid
15
17
  按照【接收用户ID】进行过滤。
16
18
  类型:String
19
+ 示例:"Filters": [{Key: "uid", Values: ["1137546"]}]
17
20
  必选:否</li>
18
21
  <li> groupId
19
22
  按照【接收用户组ID】进行过滤。
20
23
  类型:String
24
+ 示例:"Filters": [{Key: "groupId", Values: ["344098"]}]
21
25
  必选:否</li>
22
26
 
23
27
  <li> deliverFlag
@@ -25,7 +29,7 @@ export interface DescribeAlarmNoticesRequest {
25
29
  类型:String
26
30
  必选:否
27
31
  可选值: "1":未启用, "2": 已启用, "3":投递异常</li>
28
-
32
+ 示例:"Filters":[{"Key":"deliverFlag","Values":["2"]}]
29
33
  每次请求的Filters的上限为10,Filter.Values的上限为5。
30
34
  */
31
35
  Filters?: Array<Filter>;
@@ -68,7 +72,7 @@ export interface AlarmInfo {
68
72
  */
69
73
  MonitorTime?: MonitorTime;
70
74
  /**
71
- * 单触发条件。与MultiConditions参数互斥。
75
+ * 是否触发告警的单触发条件。与MultiConditions参数互斥。
72
76
  */
73
77
  Condition?: string;
74
78
  /**
@@ -92,11 +96,11 @@ export interface AlarmInfo {
92
96
  */
93
97
  AlarmId?: string;
94
98
  /**
95
- * 创建时间。
99
+ * 创建时间。格式: YYYY-MM-DD HH:MM:SS
96
100
  */
97
101
  CreateTime?: string;
98
102
  /**
99
- * 最近更新时间。
103
+ * 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
100
104
  */
101
105
  UpdateTime?: string;
102
106
  /**
@@ -710,6 +714,25 @@ export interface CreateScheduledSqlResponse {
710
714
  */
711
715
  RequestId?: string;
712
716
  }
717
+ /**
718
+ * 通知内容模板详细配置
719
+ */
720
+ export interface NoticeContent {
721
+ /**
722
+ * 渠道类型
723
+
724
+ Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
725
+ */
726
+ Type: string;
727
+ /**
728
+ * 告警触发通知内容模板。
729
+ */
730
+ TriggerContent?: NoticeContentInfo;
731
+ /**
732
+ * 告警恢复通知内容模板。
733
+ */
734
+ RecoveryContent?: NoticeContentInfo;
735
+ }
713
736
  /**
714
737
  * DescribeDashboards请求参数结构体
715
738
  */
@@ -724,19 +747,46 @@ export interface DescribeDashboardsRequest {
724
747
  Limit?: number;
725
748
  /**
726
749
  * - dashboardId 按照【仪表盘id】进行过滤,类型:String, 必选:否。
750
+ - 示例值:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
727
751
  - dashboardName 按照【仪表盘名字】进行模糊搜索过滤,类型:String,必选:否。
728
- - dashboardRegion 按照【仪表盘地域】进行过滤,为了兼容老的仪表盘,通过云API创建的仪表盘没有地域属性,类型:String,必选:否。 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940),例如:ap-guangzhou
752
+ - 示例值:业务大盘
753
+ - dashboardRegion 按照【仪表盘地域】进行过滤(兼容老的仪表盘),通过云API创建的仪表盘该属性,类型:String,必选:否。
754
+ - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
755
+ - 示例:ap-guangzhou
729
756
  - tagKey 按照【标签键】进行过滤,类型:String,必选:否。
730
- - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,使用请参考[示例2](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B)。
757
+ - 示例值:
758
+ ```
759
+ "Filters":[
760
+ {
761
+ "Key": "tagKey",
762
+ "Values": [
763
+ "tag-key-test"
764
+ ]
765
+ }
766
+ ]
767
+ ```
768
+
769
+ - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,
770
+ - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。
771
+ ```
772
+ "Filters": [
773
+ {
774
+ "Key": "tag:tag-key-test",
775
+ "Values": [
776
+ "12"
777
+ ]
778
+ }
779
+ ]
780
+ ```
731
781
 
732
782
  每次请求的Filters的上限为10,Filter.Values的上限为100。
733
783
  */
734
784
  Filters?: Array<Filter>;
735
785
  /**
736
786
  * 按照topicId和regionId过滤。
737
-
738
787
  - topicId:日志主题Id。
739
788
  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
789
+ - 示例值:439a5304-08f9-484b-9c4d-46ff57133816
740
790
  - regionId
741
791
  - 1:广州
742
792
  - 4:上海
@@ -1772,31 +1822,40 @@ export interface NoticeRule {
1772
1822
  */
1773
1823
  export interface DashboardNoticeMode {
1774
1824
  /**
1775
- * 仪表盘通知方式。<br>
1776
- <li/>Uin:腾讯云用户<br>
1777
- <li/>Group:腾讯云用户组<br>
1778
- <li/>Email:自定义Email<br>
1779
- <li/>WeCom: 企业微信回调<br>
1780
- <li/>DingTalk:钉钉<br>
1781
- <li/>Lark:飞书
1825
+ * 仪表盘通知方式。
1826
+
1827
+ - Uin:腾讯云用户
1828
+ - Group:腾讯云用户组
1829
+ - WeCom:企业微信回调
1830
+ - Email:自定义邮件
1831
+ - DingTalk:钉钉
1832
+ - Lark:飞书
1782
1833
  */
1783
1834
  ReceiverType: string;
1784
1835
  /**
1785
1836
  * 知方式对应的值。
1786
- <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
1837
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Values必须为空,且Url字段必填。
1838
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Values必填,且Url字段必须为空。
1839
+ - 当ReceiverType为:`Uin ` 时,Values为用户id,通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。
1840
+ - 当ReceiverType为:`Group` 时,Values为用户组id,通过 [查询用户组列表](https://cloud.tencent.com/document/product/598/34589) 获取用户组 ID 。
1841
+ - 当ReceiverType为:`Email` 时,Values为用户邮箱信息。
1787
1842
  */
1788
1843
  Values?: Array<string>;
1789
1844
  /**
1790
1845
  * 仪表盘通知渠道。
1791
- <br><li/> 支持:["Email","Sms","WeChat","Phone"]。
1792
- <br><li/> 当ReceiverType是 Email 或 WeCom 时,ReceiverChannels不能赋值。
1846
+
1847
+ - 支持:["Email","Sms","WeChat","Phone"]。
1848
+ - 当ReceiverType为 `Email` 或 `WeCom` 时,ReceiverChannels无效。
1793
1849
  注意:此字段可能返回 null,表示取不到有效值。
1794
1850
  */
1795
1851
  ReceiverChannels?: Array<string>;
1796
1852
  /**
1797
- * 回调Url。
1798
- <br><li/> 当ReceiverTypeWeCom 时,Url必填。
1799
- <br><li/> 当ReceiverType不是 WeCom 时,Url不能填写。
1853
+ * 订阅方式 - 回调地址。
1854
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Url字段必填为各渠道的回调地址。
1855
+ - 为:`WeCom` 时,Url为 企业微信回调地址。
1856
+ - 为:`DingTalk` 时,Url为 钉钉机器人Webhook地址。
1857
+ - 为:`Lark` 时,Url为 飞书机器人Webhook地址。
1858
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Url字段必须为空。
1800
1859
  */
1801
1860
  Url?: string;
1802
1861
  }
@@ -2015,7 +2074,7 @@ export interface ModifyTopicRequest {
2015
2074
  PartitionCount?: number;
2016
2075
  /**
2017
2076
  * 取消切换存储任务的id
2018
- - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id
2077
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id【Topics中的TopicAsyncTaskID字段】。
2019
2078
  */
2020
2079
  CancelTopicAsyncTaskID?: string;
2021
2080
  }
@@ -2370,7 +2429,7 @@ export interface QueryMetricResponse {
2370
2429
  */
2371
2430
  export interface DescribeAlarmShieldsRequest {
2372
2431
  /**
2373
- * 通知渠道组id
2432
+ * 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组id
2374
2433
  */
2375
2434
  AlarmNoticeId: string;
2376
2435
  /**
@@ -2444,11 +2503,11 @@ export interface WebCallbackInfo {
2444
2503
  */
2445
2504
  SubUin?: number;
2446
2505
  /**
2447
- * 创建时间。秒级时间戳
2506
+ * 创建时间。秒(s)级时间戳
2448
2507
  */
2449
2508
  CreateTime?: number;
2450
2509
  /**
2451
- * 更新时间。秒级时间戳
2510
+ * 更新时间。秒(s)级时间戳
2452
2511
  */
2453
2512
  UpdateTime?: number;
2454
2513
  }
@@ -2514,11 +2573,11 @@ export interface DescribeConfigMachineGroupsResponse {
2514
2573
  */
2515
2574
  export interface ModifyAlarmRequest {
2516
2575
  /**
2517
- * 告警策略ID
2576
+ * 告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID
2518
2577
  */
2519
2578
  AlarmId: string;
2520
2579
  /**
2521
- * 告警策略名称
2580
+ * 告警策略名称。最大支持255个字节,不支持 '|'。
2522
2581
  */
2523
2582
  Name?: string;
2524
2583
  /**
@@ -2526,7 +2585,7 @@ export interface ModifyAlarmRequest {
2526
2585
  */
2527
2586
  MonitorTime?: MonitorTime;
2528
2587
  /**
2529
- * 触发条件。
2588
+ * 告警信息发送的触发条件。
2530
2589
 
2531
2590
  注意:
2532
2591
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
@@ -2557,7 +2616,7 @@ export interface ModifyAlarmRequest {
2557
2616
  */
2558
2617
  AlarmPeriod?: number;
2559
2618
  /**
2560
- * 关联的告警通知模板列表。
2619
+ * 关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表
2561
2620
  */
2562
2621
  AlarmNoticeIds?: Array<string>;
2563
2622
  /**
@@ -2642,7 +2701,7 @@ export interface LogItems {
2642
2701
  */
2643
2702
  export interface ModifyAlarmNoticeRequest {
2644
2703
  /**
2645
- * 通知渠道组ID
2704
+ * 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
2646
2705
  */
2647
2706
  AlarmNoticeId: string;
2648
2707
  /**
@@ -2753,7 +2812,7 @@ export interface EventLog {
2753
2812
  */
2754
2813
  export interface CreateAlarmRequest {
2755
2814
  /**
2756
- * 告警策略名称
2815
+ * 告警策略名称。最大支持255个字节。 不支持 '|'。
2757
2816
  */
2758
2817
  Name: string;
2759
2818
  /**
@@ -2773,11 +2832,11 @@ export interface CreateAlarmRequest {
2773
2832
  */
2774
2833
  AlarmPeriod: number;
2775
2834
  /**
2776
- * 关联的告警通知模板列表。
2835
+ * 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表
2777
2836
  */
2778
2837
  AlarmNoticeIds: Array<string>;
2779
2838
  /**
2780
- * 触发条件
2839
+ * 告警发送通知的触发条件
2781
2840
  注意:
2782
2841
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
2783
2842
 
@@ -2878,6 +2937,7 @@ export interface DescribeDashboardSubscribesRequest {
2878
2937
  * dashboardId:按照【仪表盘id】进行过滤。类型:String必选:否
2879
2938
 
2880
2939
  - 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。
2940
+ - 入参示例:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
2881
2941
 
2882
2942
  每次请求的Filters的上限为10,Filter.Values的上限为100。
2883
2943
  */
@@ -2988,11 +3048,11 @@ export interface NoticeContentTemplate {
2988
3048
  */
2989
3049
  SubUin?: number;
2990
3050
  /**
2991
- * 创建时间 秒级时间戳。
3051
+ * 创建时间 秒级(s)时间戳。
2992
3052
  */
2993
3053
  CreateTime?: number;
2994
3054
  /**
2995
- * 更新时间 秒级时间戳。
3055
+ * 更新时间 秒级(s)时间戳。
2996
3056
  */
2997
3057
  UpdateTime?: number;
2998
3058
  }
@@ -3051,6 +3111,7 @@ export interface CreateConfigExtraRequest {
3051
3111
  Name: string;
3052
3112
  /**
3053
3113
  * 日志主题id
3114
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
3054
3115
  */
3055
3116
  TopicId: string;
3056
3117
  /**
@@ -3076,18 +3137,23 @@ export interface CreateConfigExtraRequest {
3076
3137
  ConfigFlag: string;
3077
3138
  /**
3078
3139
  * 日志集id
3140
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3079
3141
  */
3080
3142
  LogsetId: string;
3081
3143
  /**
3082
- * 日志集name
3144
+ * 日志集名称
3145
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
3083
3146
  */
3084
3147
  LogsetName: string;
3085
3148
  /**
3086
3149
  * 日志主题名称
3150
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
3087
3151
  */
3088
3152
  TopicName: string;
3089
3153
  /**
3090
- * 节点文件路径类型配置。
3154
+ * 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
3155
+
3156
+ - 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 信息。
3091
3157
  */
3092
3158
  HostFile?: HostFileInfo;
3093
3159
  /**
@@ -3095,7 +3161,9 @@ export interface CreateConfigExtraRequest {
3095
3161
  */
3096
3162
  ContainerFile?: ContainerFileInfo;
3097
3163
  /**
3098
- * 容器标准输出类型配置。
3164
+ * 自建k8s-容器标准输出信息,包括容器、命名空间等。
3165
+
3166
+ - 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 信息。
3099
3167
  */
3100
3168
  ContainerStdout?: ContainerStdoutInfo;
3101
3169
  /**
@@ -3120,15 +3188,19 @@ export interface CreateConfigExtraRequest {
3120
3188
  */
3121
3189
  UserDefineRule?: string;
3122
3190
  /**
3123
- * 绑定的机器组id
3191
+ * 绑定的机器组ID
3192
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3193
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
3124
3194
  */
3125
3195
  GroupId?: string;
3126
3196
  /**
3127
- * 绑定的机器组id列表
3197
+ * 绑定的机器组ID列表
3198
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。
3199
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
3128
3200
  */
3129
3201
  GroupIds?: Array<string>;
3130
3202
  /**
3131
- * 采集相关配置信息。详情见CollectInfo复杂类型配置。
3203
+ * 采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) 信息。
3132
3204
  */
3133
3205
  CollectInfos?: Array<CollectInfo>;
3134
3206
  /**
@@ -3358,15 +3430,15 @@ export interface CheckRechargeKafkaServerRequest {
3358
3430
  */
3359
3431
  export interface CreateAlarmShieldRequest {
3360
3432
  /**
3361
- * 通知渠道组id
3433
+ * 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id
3362
3434
  */
3363
3435
  AlarmNoticeId: string;
3364
3436
  /**
3365
- * 屏蔽开始时间(秒级时间戳)。
3437
+ * 屏蔽规则开始时间,秒级(s)时间戳。
3366
3438
  */
3367
3439
  StartTime: number;
3368
3440
  /**
3369
- * 屏蔽结束时间(秒级时间戳)。
3441
+ * 屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间
3370
3442
  */
3371
3443
  EndTime: number;
3372
3444
  /**
@@ -3732,7 +3804,7 @@ export interface DescribeCosRechargesRequest {
3732
3804
  */
3733
3805
  export interface AlarmTarget {
3734
3806
  /**
3735
- * 日志主题ID
3807
+ * 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
3736
3808
  */
3737
3809
  TopicId: string;
3738
3810
  /**
@@ -3752,7 +3824,7 @@ export interface AlarmTarget {
3752
3824
  */
3753
3825
  EndTimeOffset: number;
3754
3826
  /**
3755
- * 日志集ID
3827
+ * 日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID
3756
3828
  */
3757
3829
  LogsetId: string;
3758
3830
  /**
@@ -3821,7 +3893,7 @@ export interface ModifyScheduledSqlRequest {
3821
3893
  */
3822
3894
  ProcessDelay?: number;
3823
3895
  /**
3824
- * 源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
3896
+ * 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
3825
3897
  */
3826
3898
  SrcTopicRegion?: string;
3827
3899
  /**
@@ -3955,7 +4027,7 @@ export interface NoticeContentInfo {
3955
4027
  */
3956
4028
  export interface CreateWebCallbackRequest {
3957
4029
  /**
3958
- * 通知内容名称。
4030
+ * 通知内容名称。最大支持255个字节
3959
4031
  */
3960
4032
  Name: string;
3961
4033
  /**
@@ -3975,7 +4047,7 @@ export interface CreateWebCallbackRequest {
3975
4047
  */
3976
4048
  Method?: string;
3977
4049
  /**
3978
- * 秘钥。
4050
+ * 秘钥。最大支持1024个字节
3979
4051
  */
3980
4052
  Key?: string;
3981
4053
  }
@@ -4188,11 +4260,11 @@ export interface ModifyConsumerResponse {
4188
4260
  */
4189
4261
  export interface DescribeAlertRecordHistoryRequest {
4190
4262
  /**
4191
- * 查询时间范围启始时间,毫秒级unix时间戳
4263
+ * 查询时间范围启始时间,毫秒级unix时间戳(ms)
4192
4264
  */
4193
4265
  From: number;
4194
4266
  /**
4195
- * 查询时间范围结束时间,毫秒级unix时间戳
4267
+ * 查询时间范围结束时间,毫秒级unix时间戳(ms)
4196
4268
  */
4197
4269
  To: number;
4198
4270
  /**
@@ -4383,7 +4455,8 @@ export interface AnalysisDimensional {
4383
4455
  */
4384
4456
  Name: string;
4385
4457
  /**
4386
- * 分析类型:query,field ,original
4458
+ * 分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志)
4459
+
4387
4460
  */
4388
4461
  Type: string;
4389
4462
  /**
@@ -4440,7 +4513,7 @@ export interface AnalysisDimensional {
4440
4513
  */
4441
4514
  export interface DeleteWebCallbackRequest {
4442
4515
  /**
4443
- * 告警渠道回调配置ID
4516
+ * 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
4444
4517
  */
4445
4518
  WebCallbackId: string;
4446
4519
  }
@@ -4603,7 +4676,7 @@ export interface LogRechargeRuleInfo {
4603
4676
  export interface DeleteCosRechargeRequest {
4604
4677
  /**
4605
4678
  * COS导入配置Id。
4606
- - 通过[获取投递任务列表](https://cloud.tencent.com/document/api/614/58745)获取COS导入配置Id。
4679
+ - 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。
4607
4680
  */
4608
4681
  Id: string;
4609
4682
  /**
@@ -4759,19 +4832,19 @@ export interface DescribeAlarmNoticesResponse {
4759
4832
  */
4760
4833
  export interface ModifyAlarmShieldRequest {
4761
4834
  /**
4762
- * 屏蔽规则ID
4835
+ * 屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
4763
4836
  */
4764
4837
  TaskId: string;
4765
4838
  /**
4766
- * 通知渠道组id
4839
+ * 通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
4767
4840
  */
4768
4841
  AlarmNoticeId: string;
4769
4842
  /**
4770
- * 屏蔽开始时间(秒级时间戳)。
4843
+ * 屏蔽开始时间,秒级(s)时间戳。
4771
4844
  */
4772
4845
  StartTime?: number;
4773
4846
  /**
4774
- * 屏蔽结束时间(秒级时间戳)。
4847
+ * 屏蔽结束时间,秒级(s)时间戳。
4775
4848
  */
4776
4849
  EndTime?: number;
4777
4850
  /**
@@ -4788,6 +4861,7 @@ export interface ModifyAlarmShieldRequest {
4788
4861
  Reason?: string;
4789
4862
  /**
4790
4863
  * 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。
4864
+ 枚举:0(未生效),1(生效中),2(已失效)
4791
4865
  */
4792
4866
  Status?: number;
4793
4867
  }
@@ -4945,7 +5019,8 @@ export interface ModifyConfigRequest {
4945
5019
  */
4946
5020
  export interface AddMachineGroupInfoRequest {
4947
5021
  /**
4948
- * 机器组ID
5022
+ * 机器组Id
5023
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4949
5024
  */
4950
5025
  GroupId: string;
4951
5026
  /**
@@ -5034,11 +5109,11 @@ export interface PreviewKafkaRechargeResponse {
5034
5109
  */
5035
5110
  export interface ModifyWebCallbackRequest {
5036
5111
  /**
5037
- * 告警渠道回调配置ID
5112
+ * 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
5038
5113
  */
5039
5114
  WebCallbackId: string;
5040
5115
  /**
5041
- * 告警渠道回调配置名称。
5116
+ * 告警渠道回调配置名称。最大支持255个字节
5042
5117
  */
5043
5118
  Name?: string;
5044
5119
  /**
@@ -5060,7 +5135,7 @@ export interface ModifyWebCallbackRequest {
5060
5135
  */
5061
5136
  Method?: string;
5062
5137
  /**
5063
- * 秘钥信息。
5138
+ * 秘钥信息。最大支持1024个字节
5064
5139
  */
5065
5140
  Key?: string;
5066
5141
  }
@@ -5170,10 +5245,10 @@ export interface DeleteAlarmResponse {
5170
5245
  export interface WebCallback {
5171
5246
  /**
5172
5247
  * 回调的类型。可选值:
5173
- - Http
5174
- - WeCom
5175
- - DingTalk
5176
- - Lark
5248
+ - Http(自定义接口回调)
5249
+ - WeCom(企业微信)
5250
+ - DingTalk(钉钉)
5251
+ - Lark(飞书)
5177
5252
  */
5178
5253
  CallbackType: string;
5179
5254
  /**
@@ -5182,7 +5257,7 @@ export interface WebCallback {
5182
5257
  */
5183
5258
  Url: string;
5184
5259
  /**
5185
- * 集成配置ID
5260
+ * 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
5186
5261
  */
5187
5262
  WebCallbackId?: string;
5188
5263
  /**
@@ -5412,7 +5487,7 @@ export interface AlertHistoryRecord {
5412
5487
  */
5413
5488
  TriggerCount: number;
5414
5489
  /**
5415
- * 告警通知发送频率,单位为分钟
5490
+ * 告警通知发送频率,单位为分钟(min)
5416
5491
  */
5417
5492
  AlarmPeriod: number;
5418
5493
  /**
@@ -5420,7 +5495,7 @@ export interface AlertHistoryRecord {
5420
5495
  */
5421
5496
  Notices: Array<AlertHistoryNotice>;
5422
5497
  /**
5423
- * 告警持续时间,单位为分钟
5498
+ * 告警持续时间,单位为分钟(min)
5424
5499
  */
5425
5500
  Duration: number;
5426
5501
  /**
@@ -5428,7 +5503,7 @@ export interface AlertHistoryRecord {
5428
5503
  */
5429
5504
  Status: number;
5430
5505
  /**
5431
- * 告警发生时间,毫秒级Unix时间戳
5506
+ * 告警发生时间,毫秒级Unix时间戳(ms)
5432
5507
  */
5433
5508
  CreateTime: number;
5434
5509
  /**
@@ -6083,23 +6158,53 @@ export interface SearchLogResponse {
6083
6158
  RequestId?: string;
6084
6159
  }
6085
6160
  /**
6086
- * 通知内容模板详细配置
6161
+ * 仪表盘订阅信息
6087
6162
  */
6088
- export interface NoticeContent {
6163
+ export interface DashboardSubscribeInfo {
6089
6164
  /**
6090
- * 渠道类型
6091
-
6092
- Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
6165
+ * 仪表盘订阅id。
6093
6166
  */
6094
- Type: string;
6167
+ Id?: number;
6095
6168
  /**
6096
- * 告警触发通知内容模板。
6169
+ * 仪表盘订阅名称。
6097
6170
  */
6098
- TriggerContent?: NoticeContentInfo;
6171
+ Name?: string;
6099
6172
  /**
6100
- * 告警恢复通知内容模板。
6173
+ * 仪表盘id。
6101
6174
  */
6102
- RecoveryContent?: NoticeContentInfo;
6175
+ DashboardId?: string;
6176
+ /**
6177
+ * 仪表盘订阅时间。
6178
+ */
6179
+ Cron?: string;
6180
+ /**
6181
+ * 仪表盘订阅数据。
6182
+ */
6183
+ SubscribeData?: DashboardSubscribeData;
6184
+ /**
6185
+ * 仪表盘订阅记录创建时间。格式:`YYYY-MM-DD HH:MM:SS`
6186
+ */
6187
+ CreateTime?: string;
6188
+ /**
6189
+ * 仪表盘订阅记录更新时间。格式:`YYYY-MM-DD HH:MM:SS`
6190
+ */
6191
+ UpdateTime?: string;
6192
+ /**
6193
+ * 仪表盘订阅记录最后一次发送成功时间。格式:`YYYY-MM-DD HH:MM:SS`
6194
+ */
6195
+ LastTime?: string;
6196
+ /**
6197
+ * 腾讯云主账号Id。
6198
+ */
6199
+ Uin?: number;
6200
+ /**
6201
+ * 腾讯云主账号下的子账号Id。
6202
+ */
6203
+ SubUin?: number;
6204
+ /**
6205
+ * 仪表盘订阅记录最后一次发送的状态。success:全部发送成功,fail:未发送, partialSuccess:部分发送成功。
6206
+ */
6207
+ LastStatus?: string;
6103
6208
  }
6104
6209
  /**
6105
6210
  * CheckFunction返回参数结构体
@@ -6351,7 +6456,7 @@ export interface NoticeReceiver {
6351
6456
  */
6352
6457
  ReceiverChannels: Array<string>;
6353
6458
  /**
6354
- * 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)
6459
+ * 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
6355
6460
  */
6356
6461
  NoticeContentId?: string;
6357
6462
  /**
@@ -6568,11 +6673,11 @@ export interface AlarmNotice {
6568
6673
  */
6569
6674
  AlarmNoticeDeliverConfig?: AlarmNoticeDeliverConfig;
6570
6675
  /**
6571
- * 创建时间。
6676
+ * 创建时间。格式: YYYY-MM-DD HH:MM:SS
6572
6677
  */
6573
6678
  CreateTime?: string;
6574
6679
  /**
6575
- * 最近更新时间。
6680
+ * 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
6576
6681
  */
6577
6682
  UpdateTime?: string;
6578
6683
  }
@@ -6590,7 +6695,7 @@ export interface ModifyConfigResponse {
6590
6695
  */
6591
6696
  export interface ModifyNoticeContentRequest {
6592
6697
  /**
6593
- * 通知内容模板ID
6698
+ * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
6594
6699
  */
6595
6700
  NoticeContentId: string;
6596
6701
  /**
@@ -7028,22 +7133,26 @@ export interface DescribeAlarmsRequest {
7028
7133
  - 按照【告警策略名称】进行过滤。
7029
7134
  - 类型:String
7030
7135
  - 必选:否
7136
+ - 示例:test-alarm
7031
7137
 
7032
7138
  alarmId
7033
7139
  - 按照【告警策略ID】进行过滤。
7034
7140
  - 类型:String
7035
7141
  - 必选:否
7142
+ - 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
7036
7143
 
7037
7144
  topicId
7038
7145
  - 按照【监控对象的日志主题ID】进行过滤。
7039
7146
  - 类型:String
7040
7147
  - 必选:否
7148
+ - 示例:6766f83d-659e-xxxx-a8f7-9104a1012743
7041
7149
 
7042
7150
  enable
7043
7151
  - 按照【启用状态】进行过滤。
7044
7152
  - 类型:String
7045
7153
  - 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
7046
7154
  - 必选:否
7155
+ - 示例:true
7047
7156
 
7048
7157
  每次请求的Filters的上限为10,Filter.Values的上限为5。
7049
7158
  */
@@ -7081,6 +7190,14 @@ export interface QueryMetricRequest {
7081
7190
  * DescribeDashboardSubscribes返回参数结构体
7082
7191
  */
7083
7192
  export interface DescribeDashboardSubscribesResponse {
7193
+ /**
7194
+ * 仪表盘订阅列表
7195
+ */
7196
+ DashboardSubscribeInfos?: Array<DashboardSubscribeInfo>;
7197
+ /**
7198
+ * 总数目
7199
+ */
7200
+ TotalCount?: number;
7084
7201
  /**
7085
7202
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7086
7203
  */
@@ -7395,7 +7512,7 @@ export interface MetricLabel {
7395
7512
  */
7396
7513
  export interface CreateNoticeContentRequest {
7397
7514
  /**
7398
- * 模板名称。
7515
+ * 模板名称。最大支持255个字节
7399
7516
  */
7400
7517
  Name: string;
7401
7518
  /**
@@ -7520,7 +7637,7 @@ export interface MultiCondition {
7520
7637
  */
7521
7638
  export interface DeleteAlarmNoticeRequest {
7522
7639
  /**
7523
- * 通知渠道组ID
7640
+ * 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
7524
7641
  */
7525
7642
  AlarmNoticeId: string;
7526
7643
  }
@@ -7635,7 +7752,7 @@ export interface MonitorTime {
7635
7752
  */
7636
7753
  Time?: number;
7637
7754
  /**
7638
- * 执行的周期cron表达式。示例:`"* /1 * * * *"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。
7755
+ * 执行的周期cron表达式。示例:`"* /1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。
7639
7756
  当type为`Cron`时,CronExpression字段生效。
7640
7757
  */
7641
7758
  CronExpression?: string;
@@ -7671,7 +7788,10 @@ export interface MultiTopicSearchInformation {
7671
7788
  */
7672
7789
  export interface CreateMachineGroupRequest {
7673
7790
  /**
7674
- * 机器组名字,不能重复
7791
+ * 机器组名字。
7792
+ 输入限制:
7793
+ - 最大支持255个字符,不能为空字符串
7794
+ - 不能包含字符'|'
7675
7795
  */
7676
7796
  GroupName: string;
7677
7797
  /**
@@ -7690,10 +7810,12 @@ export interface CreateMachineGroupRequest {
7690
7810
  AutoUpdate?: boolean;
7691
7811
  /**
7692
7812
  * 升级开始时间,建议业务低峰期升级LogListener
7813
+ 时间格式:HH:mm:ss
7693
7814
  */
7694
7815
  UpdateStartTime?: string;
7695
7816
  /**
7696
7817
  * 升级结束时间,建议业务低峰期升级LogListener
7818
+ 时间格式:HH:mm:ss
7697
7819
  */
7698
7820
  UpdateEndTime?: string;
7699
7821
  /**
@@ -7702,6 +7824,8 @@ export interface CreateMachineGroupRequest {
7702
7824
  ServiceLogging?: boolean;
7703
7825
  /**
7704
7826
  * 机器组中机器离线清理时间。单位:天
7827
+
7828
+ - 大于0时生效。
7705
7829
  */
7706
7830
  DelayCleanupTime?: number;
7707
7831
  /**
@@ -7933,7 +8057,7 @@ export interface DescribeCloudProductLogTasksRequest {
7933
8057
  */
7934
8058
  export interface CreateAlarmNoticeRequest {
7935
8059
  /**
7936
- * 通知渠道组名称。
8060
+ * 通知渠道组名称。最大支持255个字节。 不支持 '|'。
7937
8061
  */
7938
8062
  Name: string;
7939
8063
  /**
@@ -8076,16 +8200,21 @@ export interface ModifyConfigExtraRequest {
8076
8200
  */
8077
8201
  TopicId?: string;
8078
8202
  /**
8079
- * 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
8203
+ * 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
8204
+
8205
+ - 详情参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 文档。
8080
8206
  */
8081
8207
  HostFile?: HostFileInfo;
8082
8208
  /**
8083
8209
  * 采集配置标记。
8084
8210
  - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
8211
+ - 详情参考 [ ContainerFileInfo](https://cloud.tencent.com/document/api/614/56471#ContainerFileInfo) 文档
8085
8212
  */
8086
8213
  ContainerFile?: ContainerFileInfo;
8087
8214
  /**
8088
- * 自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
8215
+ * 自建k8s-容器标准输出信息,包括容器、命名空间等,
8216
+
8217
+ - 详情参考 [ContainerStdoutInfo]( https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 文档
8089
8218
  */
8090
8219
  ContainerStdout?: ContainerStdoutInfo;
8091
8220
  /**
@@ -8107,7 +8236,7 @@ export interface ModifyConfigExtraRequest {
8107
8236
  */
8108
8237
  LogFormat?: string;
8109
8238
  /**
8110
- * 提取规则,如果设置了ExtractRule,则必须设置LogType
8239
+ * 提取规则,如果设置了ExtractRule,则必须设置LogType
8111
8240
  */
8112
8241
  ExtractRule?: ExtractRuleInfo;
8113
8242
  /**
@@ -8606,7 +8735,7 @@ export interface DescribeWebCallbacksRequest {
8606
8735
  按照【告警渠道回调配置渠道类型】进行过滤。
8607
8736
  类型:String
8608
8737
  必选:否
8609
-
8738
+ 枚举值:WeCom,DingTalk,Lark,Http
8610
8739
  每次请求的Filters的上限为10,Filter.Values的上限为100。
8611
8740
  */
8612
8741
  Filters?: Array<Filter>;
@@ -8624,7 +8753,7 @@ export interface DescribeWebCallbacksRequest {
8624
8753
  */
8625
8754
  export interface DeleteNoticeContentRequest {
8626
8755
  /**
8627
- * 通知内容模板ID
8756
+ * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
8628
8757
  */
8629
8758
  NoticeContentId: string;
8630
8759
  }
@@ -8733,13 +8862,13 @@ export interface DeliverConfig {
8733
8862
  ap-guangzhou 广州地域;
8734
8863
  ap-nanjing 南京地域。
8735
8864
 
8736
- 详细信息请查看官网:
8865
+ 详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
8866
+
8737
8867
 
8738
- https://cloud.tencent.com/document/product/614/18940
8739
8868
  */
8740
8869
  Region: string;
8741
8870
  /**
8742
- * 日志主题ID
8871
+ * 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
8743
8872
  */
8744
8873
  TopicId: string;
8745
8874
  /**