tccli 3.0.1215.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/argparser.py +1 -1
- tccli/command.py +2 -2
- tccli/configure.py +46 -1
- tccli/credentials.py +25 -0
- tccli/main.py +6 -2
- tccli/plugins/sso/__init__.py +61 -0
- tccli/plugins/sso/configs.py +4 -0
- tccli/plugins/sso/configure.py +45 -0
- tccli/plugins/sso/login.py +144 -0
- tccli/plugins/sso/logout.py +21 -0
- tccli/plugins/sso/terminal.py +161 -0
- tccli/plugins/sso/texts.py +40 -0
- tccli/services/__init__.py +6 -3
- tccli/services/acp/v20220105/api.json +7 -7
- tccli/services/acp/v20220105/examples.json +2 -2
- tccli/services/aiart/v20221229/api.json +29 -29
- tccli/services/aiart/v20221229/examples.json +8 -8
- tccli/services/apigateway/v20180808/api.json +18 -17
- tccli/services/apigateway/v20180808/examples.json +12 -12
- tccli/services/apm/v20210622/api.json +118 -4
- tccli/services/asr/v20190614/api.json +21 -20
- tccli/services/asr/v20190614/examples.json +13 -13
- tccli/services/autoscaling/v20180419/api.json +371 -309
- tccli/services/autoscaling/v20180419/examples.json +17 -17
- tccli/services/batch/v20170312/api.json +7 -7
- tccli/services/bda/v20200324/api.json +39 -31
- tccli/services/bda/v20200324/examples.json +9 -9
- tccli/services/bh/__init__.py +4 -0
- tccli/services/bh/bh_client.py +3428 -0
- tccli/services/bh/v20230418/api.json +8180 -0
- tccli/services/bh/v20230418/examples.json +519 -0
- tccli/services/bi/v20220105/api.json +80 -4
- tccli/services/bi/v20220105/examples.json +1 -1
- tccli/services/billing/billing_client.py +53 -0
- tccli/services/billing/v20180709/api.json +330 -24
- tccli/services/billing/v20180709/examples.json +8 -0
- tccli/services/bsca/v20210811/api.json +223 -18
- tccli/services/bsca/v20210811/examples.json +4 -4
- tccli/services/btoe/v20210514/api.json +4 -4
- tccli/services/btoe/v20210514/examples.json +2 -2
- tccli/services/ca/v20230228/api.json +60 -0
- tccli/services/cam/v20190116/api.json +11 -11
- tccli/services/cat/v20180409/api.json +9 -0
- tccli/services/cbs/v20170312/api.json +200 -188
- tccli/services/cbs/v20170312/examples.json +4 -4
- tccli/services/ccc/ccc_client.py +53 -0
- tccli/services/ccc/v20200210/api.json +541 -325
- tccli/services/ccc/v20200210/examples.json +26 -18
- tccli/services/cdb/cdb_client.py +13 -13
- tccli/services/cdb/v20170320/api.json +308 -274
- tccli/services/cdb/v20170320/examples.json +38 -38
- tccli/services/cdc/v20201214/api.json +283 -270
- tccli/services/cdc/v20201214/examples.json +26 -26
- tccli/services/cdn/v20180606/api.json +5 -3
- tccli/services/cds/v20180420/api.json +82 -76
- tccli/services/cds/v20180420/examples.json +1 -1
- tccli/services/cdwch/v20200915/api.json +1 -1
- tccli/services/cdwdoris/v20211228/api.json +54 -4
- tccli/services/cdz/v20221123/api.json +41 -5
- tccli/services/cfg/v20210820/api.json +31 -0
- tccli/services/cfs/v20190719/api.json +89 -1
- tccli/services/cfs/v20190719/examples.json +1 -1
- tccli/services/cfw/cfw_client.py +0 -53
- tccli/services/cfw/v20190904/api.json +1895 -2011
- tccli/services/cfw/v20190904/examples.json +175 -171
- tccli/services/ciam/v20220331/api.json +316 -315
- tccli/services/ciam/v20220331/examples.json +49 -49
- tccli/services/ckafka/v20190819/api.json +104 -75
- tccli/services/clb/v20180317/api.json +48 -26
- tccli/services/clb/v20180317/examples.json +1 -1
- tccli/services/cloudapp/v20220530/api.json +5 -1
- tccli/services/cloudaudit/cloudaudit_client.py +30 -30
- tccli/services/cloudaudit/v20190319/api.json +254 -211
- tccli/services/cloudaudit/v20190319/examples.json +19 -19
- tccli/services/cloudstudio/v20230508/api.json +38 -37
- tccli/services/cloudstudio/v20230508/examples.json +4 -4
- tccli/services/cls/cls_client.py +216 -4
- tccli/services/cls/v20201016/api.json +935 -147
- tccli/services/cls/v20201016/examples.json +43 -5
- tccli/services/csip/v20221121/api.json +2566 -2386
- tccli/services/csip/v20221121/examples.json +108 -108
- tccli/services/cvm/v20170312/api.json +191 -112
- tccli/services/cvm/v20170312/examples.json +2 -2
- tccli/services/cwp/cwp_client.py +4 -110
- tccli/services/cwp/v20180228/api.json +6498 -6252
- tccli/services/cwp/v20180228/examples.json +372 -412
- tccli/services/cynosdb/v20190107/api.json +170 -110
- tccli/services/cynosdb/v20190107/examples.json +91 -91
- tccli/services/dasb/v20191018/api.json +859 -637
- tccli/services/dasb/v20191018/examples.json +101 -101
- tccli/services/dcdb/dcdb_client.py +114 -61
- tccli/services/dcdb/v20180411/api.json +141 -7
- tccli/services/dcdb/v20180411/examples.json +32 -0
- tccli/services/dlc/v20210125/api.json +21 -11
- tccli/services/dnspod/dnspod_client.py +417 -46
- tccli/services/dnspod/v20210323/api.json +751 -30
- tccli/services/dnspod/v20210323/examples.json +62 -0
- tccli/services/domain/v20180808/api.json +3 -3
- tccli/services/domain/v20180808/examples.json +3 -3
- tccli/services/dts/v20211206/api.json +4 -4
- tccli/services/eb/v20210416/api.json +15 -15
- tccli/services/eb/v20210416/examples.json +1 -1
- tccli/services/ecm/v20190719/api.json +2 -2
- tccli/services/emr/v20190103/api.json +339 -114
- tccli/services/emr/v20190103/examples.json +64 -82
- tccli/services/es/es_client.py +249 -37
- tccli/services/es/v20180416/api.json +550 -0
- tccli/services/es/v20180416/examples.json +33 -1
- tccli/services/ess/ess_client.py +53 -0
- tccli/services/ess/v20201111/api.json +192 -38
- tccli/services/ess/v20201111/examples.json +35 -9
- tccli/services/essbasic/essbasic_client.py +106 -0
- tccli/services/essbasic/v20210526/api.json +287 -60
- tccli/services/essbasic/v20210526/examples.json +58 -18
- tccli/services/facefusion/v20181201/api.json +47 -45
- tccli/services/facefusion/v20181201/examples.json +2 -2
- tccli/services/facefusion/v20220927/api.json +54 -48
- tccli/services/facefusion/v20220927/examples.json +5 -5
- tccli/services/faceid/v20180301/api.json +497 -496
- tccli/services/faceid/v20180301/examples.json +219 -101
- tccli/services/fmu/v20191213/api.json +59 -67
- tccli/services/fmu/v20191213/examples.json +22 -22
- tccli/services/ft/v20200304/api.json +53 -57
- tccli/services/ft/v20200304/examples.json +14 -14
- tccli/services/gaap/v20180529/api.json +44 -26
- tccli/services/gaap/v20180529/examples.json +24 -30
- tccli/services/gme/v20180711/api.json +21 -11
- tccli/services/gme/v20180711/examples.json +1 -1
- tccli/services/hai/v20230812/api.json +116 -9
- tccli/services/hai/v20230812/examples.json +4 -4
- tccli/services/hunyuan/hunyuan_client.py +436 -12
- tccli/services/hunyuan/v20230901/api.json +1482 -118
- tccli/services/hunyuan/v20230901/examples.json +82 -18
- tccli/services/iai/v20180301/api.json +23 -19
- tccli/services/iai/v20180301/examples.json +2 -2
- tccli/services/iai/v20200303/api.json +530 -511
- tccli/services/iai/v20200303/examples.json +116 -86
- tccli/services/ig/__init__.py +4 -0
- tccli/services/ig/ig_client.py +195 -0
- tccli/services/ig/v20210518/api.json +83 -0
- tccli/services/ig/v20210518/examples.json +13 -0
- tccli/services/ioa/ioa_client.py +53 -0
- tccli/services/ioa/v20220601/api.json +662 -413
- tccli/services/ioa/v20220601/examples.json +24 -10
- tccli/services/iotexplorer/v20190423/api.json +73 -13
- tccli/services/iotexplorer/v20190423/examples.json +3 -3
- tccli/services/iotvideo/iotvideo_client.py +106 -0
- tccli/services/iotvideo/v20191126/api.json +256 -24
- tccli/services/iotvideo/v20191126/examples.json +19 -3
- tccli/services/iotvideo/v20201215/api.json +1 -1
- tccli/services/iotvideo/v20201215/examples.json +1 -1
- tccli/services/iotvideo/v20211125/api.json +1 -1
- tccli/services/iotvideo/v20211125/examples.json +2 -2
- tccli/services/iss/iss_client.py +69 -122
- tccli/services/iss/v20230517/api.json +10 -54
- tccli/services/iss/v20230517/examples.json +0 -14
- tccli/services/kms/v20190118/api.json +301 -268
- tccli/services/kms/v20190118/examples.json +45 -51
- tccli/services/lcic/lcic_client.py +159 -0
- tccli/services/lcic/v20220817/api.json +273 -1
- tccli/services/lcic/v20220817/examples.json +24 -0
- tccli/services/lighthouse/v20200324/api.json +56 -0
- tccli/services/live/live_client.py +159 -0
- tccli/services/live/v20180801/api.json +279 -9
- tccli/services/live/v20180801/examples.json +24 -0
- tccli/services/lke/v20231130/api.json +17 -17
- tccli/services/lke/v20231130/examples.json +19 -25
- tccli/services/mariadb/v20170312/api.json +7 -7
- tccli/services/market/v20191010/api.json +3 -3
- tccli/services/market/v20191010/examples.json +2 -2
- tccli/services/mmps/v20200710/api.json +47 -47
- tccli/services/mmps/v20200710/examples.json +3 -3
- tccli/services/mongodb/v20190725/api.json +10 -12
- tccli/services/monitor/v20180724/api.json +46 -19
- tccli/services/mps/v20190612/api.json +282 -5
- tccli/services/mps/v20190612/examples.json +25 -1
- tccli/services/mqtt/v20240516/api.json +2 -2
- tccli/services/mrs/v20200910/api.json +72 -34
- tccli/services/mrs/v20200910/examples.json +2 -2
- tccli/services/ms/v20180408/api.json +535 -506
- tccli/services/ms/v20180408/examples.json +25 -25
- tccli/services/oceanus/v20190422/api.json +130 -0
- tccli/services/ocr/ocr_client.py +232 -20
- tccli/services/ocr/v20181119/api.json +2263 -758
- tccli/services/ocr/v20181119/examples.json +200 -180
- tccli/services/omics/v20221128/api.json +614 -553
- tccli/services/omics/v20221128/examples.json +9 -9
- tccli/services/organization/organization_client.py +352 -34
- tccli/services/organization/v20210331/api.json +464 -4
- tccli/services/organization/v20210331/examples.json +49 -1
- tccli/services/partners/v20180321/api.json +244 -234
- tccli/services/partners/v20180321/examples.json +19 -19
- tccli/services/privatedns/privatedns_client.py +428 -4
- tccli/services/privatedns/v20201028/api.json +815 -11
- tccli/services/privatedns/v20201028/examples.json +64 -0
- tccli/services/pts/v20210728/api.json +18 -0
- tccli/services/pts/v20210728/examples.json +1 -1
- tccli/services/rce/rce_client.py +53 -0
- tccli/services/rce/v20201103/api.json +146 -0
- tccli/services/rce/v20201103/examples.json +8 -0
- tccli/services/redis/v20180412/api.json +42 -42
- tccli/services/redis/v20180412/examples.json +19 -19
- tccli/services/region/v20220627/api.json +1 -1
- tccli/services/rum/v20210622/api.json +9 -0
- tccli/services/scf/scf_client.py +269 -4
- tccli/services/scf/v20180416/api.json +569 -15
- tccli/services/scf/v20180416/examples.json +47 -1
- tccli/services/smop/v20201203/api.json +46 -42
- tccli/services/smop/v20201203/examples.json +2 -2
- tccli/services/soe/v20180724/api.json +10 -10
- tccli/services/sqlserver/v20180328/api.json +21 -8
- tccli/services/sqlserver/v20180328/examples.json +5 -5
- tccli/services/ssl/v20191205/api.json +98 -5
- tccli/services/ssm/v20190923/api.json +292 -231
- tccli/services/ssm/v20190923/examples.json +42 -42
- tccli/services/tat/v20201028/api.json +124 -122
- tccli/services/tat/v20201028/examples.json +24 -30
- tccli/services/tchd/v20230306/api.json +5 -5
- tccli/services/tchd/v20230306/examples.json +3 -3
- tccli/services/tcr/v20190924/api.json +1 -1
- tccli/services/tcr/v20190924/examples.json +1 -1
- tccli/services/tcss/v20201101/api.json +1984 -1437
- tccli/services/tcss/v20201101/examples.json +350 -368
- tccli/services/tdmq/v20200217/api.json +603 -464
- tccli/services/tdmq/v20200217/examples.json +105 -105
- tccli/services/tds/v20220801/api.json +4 -4
- tccli/services/tem/v20210701/api.json +429 -372
- tccli/services/tem/v20210701/examples.json +85 -85
- tccli/services/teo/teo_client.py +277 -12
- tccli/services/teo/v20220901/api.json +1029 -124
- tccli/services/teo/v20220901/examples.json +84 -8
- tccli/services/thpc/v20230321/api.json +5 -5
- tccli/services/tke/tke_client.py +270 -58
- tccli/services/tke/v20180525/api.json +79 -27
- tccli/services/tke/v20180525/examples.json +9 -1
- tccli/services/tke/v20220501/api.json +176 -0
- tccli/services/tke/v20220501/examples.json +24 -0
- tccli/services/tms/tms_client.py +4 -57
- tccli/services/tms/v20201229/api.json +0 -354
- tccli/services/tms/v20201229/examples.json +0 -8
- tccli/services/tmt/v20180321/api.json +38 -8
- tccli/services/trp/v20210515/api.json +86 -74
- tccli/services/trp/v20210515/examples.json +65 -65
- tccli/services/trro/v20220325/api.json +72 -71
- tccli/services/trro/v20220325/examples.json +8 -8
- tccli/services/trtc/trtc_client.py +8 -61
- tccli/services/trtc/v20190722/api.json +293 -52
- tccli/services/trtc/v20190722/examples.json +3 -11
- tccli/services/tse/tse_client.py +110 -4
- tccli/services/tse/v20201207/api.json +122 -7
- tccli/services/tse/v20201207/examples.json +25 -9
- tccli/services/vclm/v20240523/api.json +225 -82
- tccli/services/vclm/v20240523/examples.json +13 -19
- tccli/services/vod/v20180717/api.json +431 -4
- tccli/services/vod/v20180717/examples.json +25 -5
- tccli/services/vod/v20240718/api.json +11 -11
- tccli/services/vod/v20240718/examples.json +4 -4
- tccli/services/vod/vod_client.py +53 -0
- tccli/services/vpc/v20170312/api.json +1195 -892
- tccli/services/vpc/v20170312/examples.json +84 -68
- tccli/services/vpc/vpc_client.py +168 -62
- tccli/services/waf/v20180125/api.json +2611 -2187
- tccli/services/waf/v20180125/examples.json +224 -284
- tccli/services/waf/waf_client.py +225 -119
- tccli/services/wav/v20210129/api.json +48 -48
- tccli/services/wav/v20210129/examples.json +4 -4
- tccli/services/wedata/v20210820/api.json +1595 -25
- tccli/services/wedata/v20210820/examples.json +44 -4
- tccli/services/wedata/wedata_client.py +265 -0
- tccli/services/weilingwith/v20230427/api.json +6 -6
- tccli/services/weilingwith/v20230427/examples.json +3 -3
- tccli/sso.py +229 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/METADATA +6 -2
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/RECORD +278 -265
- tccli/services/cr/__init__.py +0 -4
- tccli/services/cr/cr_client.py +0 -1626
- tccli/services/cr/v20180321/api.json +0 -2829
- tccli/services/cr/v20180321/examples.json +0 -235
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/license_files/LICENSE +0 -0
@@ -43,7 +43,7 @@
|
|
43
43
|
"status": "online"
|
44
44
|
},
|
45
45
|
"CreateAlarmNotice": {
|
46
|
-
"document": "
|
46
|
+
"document": "该接口用于创建通知渠道组,提供两种配置模式,二选一:\n1,简易模式,提供最基本的通知渠道功能。需填写如下参数:\n- Type\n- NoticeReceivers\n- WebCallbacks\n\n2,高级模式,在简易模式基础上,支持设定规则,为不同类型的告警分别设定通知渠道,并支持告警升级功能。需填写如下参数:\n- NoticeRules",
|
47
47
|
"input": "CreateAlarmNoticeRequest",
|
48
48
|
"name": "创建通知渠道组",
|
49
49
|
"output": "CreateAlarmNoticeResponse",
|
@@ -56,6 +56,13 @@
|
|
56
56
|
"output": "CreateAlarmShieldResponse",
|
57
57
|
"status": "online"
|
58
58
|
},
|
59
|
+
"CreateCloudProductLogTask": {
|
60
|
+
"document": "内部云产品接入使用相关接口",
|
61
|
+
"input": "CreateCloudProductLogTaskRequest",
|
62
|
+
"name": "创建云产品日志投递任务",
|
63
|
+
"output": "CreateCloudProductLogTaskResponse",
|
64
|
+
"status": "online"
|
65
|
+
},
|
59
66
|
"CreateConfig": {
|
60
67
|
"document": "创建采集规则配置",
|
61
68
|
"input": "CreateConfigRequest",
|
@@ -150,7 +157,7 @@
|
|
150
157
|
"CreateNoticeContent": {
|
151
158
|
"document": "该接口用于创建通知内容。",
|
152
159
|
"input": "CreateNoticeContentRequest",
|
153
|
-
"name": "
|
160
|
+
"name": "创建通知内容模板",
|
154
161
|
"output": "CreateNoticeContentResponse",
|
155
162
|
"status": "online"
|
156
163
|
},
|
@@ -196,6 +203,13 @@
|
|
196
203
|
"output": "DeleteAlarmShieldResponse",
|
197
204
|
"status": "online"
|
198
205
|
},
|
206
|
+
"DeleteCloudProductLogTask": {
|
207
|
+
"document": "内部云产品接入使用相关接口",
|
208
|
+
"input": "DeleteCloudProductLogTaskRequest",
|
209
|
+
"name": "删除云产品日志投递任务",
|
210
|
+
"output": "DeleteCloudProductLogTaskResponse",
|
211
|
+
"status": "online"
|
212
|
+
},
|
199
213
|
"DeleteConfig": {
|
200
214
|
"document": "删除采集规则配置",
|
201
215
|
"input": "DeleteConfigRequest",
|
@@ -290,7 +304,7 @@
|
|
290
304
|
"DeleteNoticeContent": {
|
291
305
|
"document": "该接口用于删除通知内容配置",
|
292
306
|
"input": "DeleteNoticeContentRequest",
|
293
|
-
"name": "
|
307
|
+
"name": "删除通知内容模板",
|
294
308
|
"output": "DeleteNoticeContentResponse",
|
295
309
|
"status": "online"
|
296
310
|
},
|
@@ -343,6 +357,13 @@
|
|
343
357
|
"output": "DescribeAlertRecordHistoryResponse",
|
344
358
|
"status": "online"
|
345
359
|
},
|
360
|
+
"DescribeCloudProductLogTasks": {
|
361
|
+
"document": "云产品接入使用相关接口",
|
362
|
+
"input": "DescribeCloudProductLogTasksRequest",
|
363
|
+
"name": "查看云产品日志投递任务列表",
|
364
|
+
"output": "DescribeCloudProductLogTasksResponse",
|
365
|
+
"status": "online"
|
366
|
+
},
|
346
367
|
"DescribeConfigExtras": {
|
347
368
|
"document": "本接口用于获取特殊采集配置,特殊采集配置应用于自建K8S环境的采集Agent",
|
348
369
|
"input": "DescribeConfigExtrasRequest",
|
@@ -479,7 +500,7 @@
|
|
479
500
|
"DescribeNoticeContents": {
|
480
501
|
"document": "获取通知内容列表",
|
481
502
|
"input": "DescribeNoticeContentsRequest",
|
482
|
-
"name": "
|
503
|
+
"name": "获取通知内容模板",
|
483
504
|
"output": "DescribeNoticeContentsResponse",
|
484
505
|
"status": "online"
|
485
506
|
},
|
@@ -553,6 +574,13 @@
|
|
553
574
|
"output": "ModifyAlarmShieldResponse",
|
554
575
|
"status": "online"
|
555
576
|
},
|
577
|
+
"ModifyCloudProductLogTask": {
|
578
|
+
"document": "内部云产品接入使用相关接口",
|
579
|
+
"input": "ModifyCloudProductLogTaskRequest",
|
580
|
+
"name": "修改云产品日志投递任务",
|
581
|
+
"output": "ModifyCloudProductLogTaskResponse",
|
582
|
+
"status": "online"
|
583
|
+
},
|
556
584
|
"ModifyConfig": {
|
557
585
|
"document": "修改采集规则配置",
|
558
586
|
"input": "ModifyConfigRequest",
|
@@ -640,7 +668,7 @@
|
|
640
668
|
"ModifyNoticeContent": {
|
641
669
|
"document": "该接口用于修改通知内容配置",
|
642
670
|
"input": "ModifyNoticeContentRequest",
|
643
|
-
"name": "
|
671
|
+
"name": "修改通知内容模板",
|
644
672
|
"output": "ModifyNoticeContentResponse",
|
645
673
|
"status": "online"
|
646
674
|
},
|
@@ -1069,18 +1097,28 @@
|
|
1069
1097
|
"usage": "out"
|
1070
1098
|
},
|
1071
1099
|
"AlarmNotice": {
|
1072
|
-
"document": "
|
1100
|
+
"document": "告警通知渠道组详细配置",
|
1073
1101
|
"members": [
|
1074
1102
|
{
|
1075
1103
|
"disabled": false,
|
1076
|
-
"document": "
|
1077
|
-
"example": "
|
1104
|
+
"document": "告警通知渠道组名称。",
|
1105
|
+
"example": "alarm",
|
1078
1106
|
"member": "string",
|
1079
1107
|
"name": "Name",
|
1080
1108
|
"output_required": true,
|
1081
1109
|
"type": "string",
|
1082
1110
|
"value_allowed_null": false
|
1083
1111
|
},
|
1112
|
+
{
|
1113
|
+
"disabled": false,
|
1114
|
+
"document": "告警通知渠道组绑定的标签信息。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1115
|
+
"example": "无",
|
1116
|
+
"member": "Tag",
|
1117
|
+
"name": "Tags",
|
1118
|
+
"output_required": true,
|
1119
|
+
"type": "list",
|
1120
|
+
"value_allowed_null": true
|
1121
|
+
},
|
1084
1122
|
{
|
1085
1123
|
"disabled": false,
|
1086
1124
|
"document": "告警模板的类型。可选值:\n<br><li> Trigger - 告警触发</li>\n<br><li> Recovery - 告警恢复</li>\n<br><li> All - 告警触发和告警恢复</li>",
|
@@ -1121,6 +1159,46 @@
|
|
1121
1159
|
"type": "string",
|
1122
1160
|
"value_allowed_null": true
|
1123
1161
|
},
|
1162
|
+
{
|
1163
|
+
"disabled": false,
|
1164
|
+
"document": "通知规则。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1165
|
+
"example": "无",
|
1166
|
+
"member": "NoticeRule",
|
1167
|
+
"name": "NoticeRules",
|
1168
|
+
"output_required": false,
|
1169
|
+
"type": "list",
|
1170
|
+
"value_allowed_null": true
|
1171
|
+
},
|
1172
|
+
{
|
1173
|
+
"disabled": false,
|
1174
|
+
"document": "免登录操作告警开关。\n参数值: 1:关闭 2:开启(默认开启)\n注意:此字段可能返回 null,表示取不到有效值。",
|
1175
|
+
"example": "2",
|
1176
|
+
"member": "uint64",
|
1177
|
+
"name": "AlarmShieldStatus",
|
1178
|
+
"output_required": false,
|
1179
|
+
"type": "int",
|
1180
|
+
"value_allowed_null": true
|
1181
|
+
},
|
1182
|
+
{
|
1183
|
+
"disabled": false,
|
1184
|
+
"document": "调用链接域名。http:// 或者 https:// 开头,不能/结尾\n注意:此字段可能返回 null,表示取不到有效值。",
|
1185
|
+
"example": "https://console.cloud.tencent.com",
|
1186
|
+
"member": "string",
|
1187
|
+
"name": "JumpDomain",
|
1188
|
+
"output_required": false,
|
1189
|
+
"type": "string",
|
1190
|
+
"value_allowed_null": true
|
1191
|
+
},
|
1192
|
+
{
|
1193
|
+
"disabled": false,
|
1194
|
+
"document": "投递相关信息。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1195
|
+
"example": "无",
|
1196
|
+
"member": "AlarmNoticeDeliverConfig",
|
1197
|
+
"name": "AlarmNoticeDeliverConfig",
|
1198
|
+
"output_required": false,
|
1199
|
+
"type": "object",
|
1200
|
+
"value_allowed_null": true
|
1201
|
+
},
|
1124
1202
|
{
|
1125
1203
|
"disabled": false,
|
1126
1204
|
"document": "创建时间。\n注意:此字段可能返回 null,表示取不到有效值。",
|
@@ -1140,15 +1218,31 @@
|
|
1140
1218
|
"output_required": true,
|
1141
1219
|
"type": "string",
|
1142
1220
|
"value_allowed_null": true
|
1143
|
-
}
|
1221
|
+
}
|
1222
|
+
],
|
1223
|
+
"usage": "out"
|
1224
|
+
},
|
1225
|
+
"AlarmNoticeDeliverConfig": {
|
1226
|
+
"document": "通知渠道投递日志配置信息",
|
1227
|
+
"members": [
|
1144
1228
|
{
|
1145
1229
|
"disabled": false,
|
1146
|
-
"document": "
|
1230
|
+
"document": "通知渠道投递日志配置信息。",
|
1147
1231
|
"example": "无",
|
1148
|
-
"member": "
|
1149
|
-
"name": "
|
1232
|
+
"member": "DeliverConfig",
|
1233
|
+
"name": "DeliverConfig",
|
1234
|
+
"output_required": true,
|
1235
|
+
"type": "object",
|
1236
|
+
"value_allowed_null": false
|
1237
|
+
},
|
1238
|
+
{
|
1239
|
+
"disabled": false,
|
1240
|
+
"document": "投递失败原因。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1241
|
+
"example": "投递失败,topicId不存在",
|
1242
|
+
"member": "string",
|
1243
|
+
"name": "ErrMsg",
|
1150
1244
|
"output_required": false,
|
1151
|
-
"type": "
|
1245
|
+
"type": "string",
|
1152
1246
|
"value_allowed_null": true
|
1153
1247
|
}
|
1154
1248
|
],
|
@@ -1946,10 +2040,10 @@
|
|
1946
2040
|
"members": [
|
1947
2041
|
{
|
1948
2042
|
"disabled": false,
|
1949
|
-
"document": "Ckafka 的
|
1950
|
-
"example": "
|
2043
|
+
"document": "Ckafka 的 InstanceId",
|
2044
|
+
"example": "ckafka-8j4rotest",
|
1951
2045
|
"member": "string",
|
1952
|
-
"name": "
|
2046
|
+
"name": "InstanceId",
|
1953
2047
|
"output_required": true,
|
1954
2048
|
"required": true,
|
1955
2049
|
"type": "string",
|
@@ -1957,10 +2051,10 @@
|
|
1957
2051
|
},
|
1958
2052
|
{
|
1959
2053
|
"disabled": false,
|
1960
|
-
"document": "Ckafka 的
|
1961
|
-
"example": "
|
2054
|
+
"document": "Ckafka 的 TopicName",
|
2055
|
+
"example": "mrxy-business",
|
1962
2056
|
"member": "string",
|
1963
|
-
"name": "
|
2057
|
+
"name": "TopicName",
|
1964
2058
|
"output_required": true,
|
1965
2059
|
"required": true,
|
1966
2060
|
"type": "string",
|
@@ -1968,45 +2062,45 @@
|
|
1968
2062
|
},
|
1969
2063
|
{
|
1970
2064
|
"disabled": false,
|
1971
|
-
"document": "Ckafka 的
|
1972
|
-
"example": "
|
2065
|
+
"document": "Ckafka 的 Vip",
|
2066
|
+
"example": "10.10.2.42",
|
1973
2067
|
"member": "string",
|
1974
|
-
"name": "
|
2068
|
+
"name": "Vip",
|
1975
2069
|
"output_required": true,
|
1976
|
-
"required":
|
2070
|
+
"required": false,
|
1977
2071
|
"type": "string",
|
1978
2072
|
"value_allowed_null": false
|
1979
2073
|
},
|
1980
2074
|
{
|
1981
2075
|
"disabled": false,
|
1982
|
-
"document": "Ckafka 的
|
1983
|
-
"example": "
|
2076
|
+
"document": "Ckafka 的 Vport",
|
2077
|
+
"example": "9092",
|
1984
2078
|
"member": "string",
|
1985
|
-
"name": "
|
2079
|
+
"name": "Vport",
|
1986
2080
|
"output_required": true,
|
1987
|
-
"required":
|
2081
|
+
"required": false,
|
1988
2082
|
"type": "string",
|
1989
2083
|
"value_allowed_null": false
|
1990
2084
|
},
|
1991
2085
|
{
|
1992
2086
|
"disabled": false,
|
1993
|
-
"document": "Ckafka 的
|
1994
|
-
"example": "
|
2087
|
+
"document": "Ckafka 的 InstanceName",
|
2088
|
+
"example": "kafka协议消费监控用",
|
1995
2089
|
"member": "string",
|
1996
|
-
"name": "
|
2090
|
+
"name": "InstanceName",
|
1997
2091
|
"output_required": true,
|
1998
|
-
"required":
|
2092
|
+
"required": false,
|
1999
2093
|
"type": "string",
|
2000
2094
|
"value_allowed_null": false
|
2001
2095
|
},
|
2002
2096
|
{
|
2003
2097
|
"disabled": false,
|
2004
|
-
"document": "Ckafka 的
|
2005
|
-
"example": "
|
2098
|
+
"document": "Ckafka 的 TopicId",
|
2099
|
+
"example": "1254011820-24a0d67e-748b-4e30-9502-78779bcc5test",
|
2006
2100
|
"member": "string",
|
2007
|
-
"name": "
|
2101
|
+
"name": "TopicId",
|
2008
2102
|
"output_required": true,
|
2009
|
-
"required":
|
2103
|
+
"required": false,
|
2010
2104
|
"type": "string",
|
2011
2105
|
"value_allowed_null": false
|
2012
2106
|
}
|
@@ -2040,6 +2134,72 @@
|
|
2040
2134
|
],
|
2041
2135
|
"type": "object"
|
2042
2136
|
},
|
2137
|
+
"CloudProductLogTaskInfo": {
|
2138
|
+
"document": "云产品日志投递任务信息",
|
2139
|
+
"members": [
|
2140
|
+
{
|
2141
|
+
"disabled": false,
|
2142
|
+
"document": "日志服务地域",
|
2143
|
+
"example": "ap-guangzhou",
|
2144
|
+
"member": "string",
|
2145
|
+
"name": "ClsRegion",
|
2146
|
+
"output_required": true,
|
2147
|
+
"type": "string",
|
2148
|
+
"value_allowed_null": false
|
2149
|
+
},
|
2150
|
+
{
|
2151
|
+
"disabled": false,
|
2152
|
+
"document": "实例ID",
|
2153
|
+
"example": "ins-r8hr2upy",
|
2154
|
+
"member": "string",
|
2155
|
+
"name": "InstanceId",
|
2156
|
+
"output_required": true,
|
2157
|
+
"type": "string",
|
2158
|
+
"value_allowed_null": false
|
2159
|
+
},
|
2160
|
+
{
|
2161
|
+
"disabled": false,
|
2162
|
+
"document": "日志集ID",
|
2163
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
2164
|
+
"member": "string",
|
2165
|
+
"name": "LogsetId",
|
2166
|
+
"output_required": true,
|
2167
|
+
"type": "string",
|
2168
|
+
"value_allowed_null": false
|
2169
|
+
},
|
2170
|
+
{
|
2171
|
+
"disabled": false,
|
2172
|
+
"document": "日志主题ID",
|
2173
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
2174
|
+
"member": "string",
|
2175
|
+
"name": "TopicId",
|
2176
|
+
"output_required": true,
|
2177
|
+
"type": "string",
|
2178
|
+
"value_allowed_null": false
|
2179
|
+
},
|
2180
|
+
{
|
2181
|
+
"disabled": false,
|
2182
|
+
"document": "日志配置拓展信息, 一般用于存储额外的日志投递配置\n注意:此字段可能返回 null,表示取不到有效值。",
|
2183
|
+
"example": "无",
|
2184
|
+
"member": "string",
|
2185
|
+
"name": "Extend",
|
2186
|
+
"output_required": false,
|
2187
|
+
"type": "string",
|
2188
|
+
"value_allowed_null": true
|
2189
|
+
},
|
2190
|
+
{
|
2191
|
+
"disabled": false,
|
2192
|
+
"document": "日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS\n注意:此字段可能返回 null,表示取不到有效值。",
|
2193
|
+
"example": "CDB-AUDIT",
|
2194
|
+
"member": "string",
|
2195
|
+
"name": "LogType",
|
2196
|
+
"output_required": false,
|
2197
|
+
"type": "string",
|
2198
|
+
"value_allowed_null": true
|
2199
|
+
}
|
2200
|
+
],
|
2201
|
+
"usage": "out"
|
2202
|
+
},
|
2043
2203
|
"CollectConfig": {
|
2044
2204
|
"document": "采集配置信息",
|
2045
2205
|
"members": [
|
@@ -3238,7 +3398,16 @@
|
|
3238
3398
|
},
|
3239
3399
|
{
|
3240
3400
|
"disabled": false,
|
3241
|
-
"document": "
|
3401
|
+
"document": "标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对,并且不能有重复的键值对。",
|
3402
|
+
"example": "无",
|
3403
|
+
"member": "Tag",
|
3404
|
+
"name": "Tags",
|
3405
|
+
"required": false,
|
3406
|
+
"type": "list"
|
3407
|
+
},
|
3408
|
+
{
|
3409
|
+
"disabled": false,
|
3410
|
+
"document": "【简易模式】(简易模式/告警模式二选一,分别配置相应参数)\n需要发送通知的告警类型。可选值:\n- Trigger - 告警触发\n- Recovery - 告警恢复\n- All - 告警触发和告警恢复",
|
3242
3411
|
"example": "All",
|
3243
3412
|
"member": "string",
|
3244
3413
|
"name": "Type",
|
@@ -3247,7 +3416,7 @@
|
|
3247
3416
|
},
|
3248
3417
|
{
|
3249
3418
|
"disabled": false,
|
3250
|
-
"document": "
|
3419
|
+
"document": "【简易模式】(简易模式/告警模式二选一,分别配置相应参数)\n通知接收对象。",
|
3251
3420
|
"example": "无",
|
3252
3421
|
"member": "NoticeReceiver",
|
3253
3422
|
"name": "NoticeReceivers",
|
@@ -3256,7 +3425,7 @@
|
|
3256
3425
|
},
|
3257
3426
|
{
|
3258
3427
|
"disabled": false,
|
3259
|
-
"document": "
|
3428
|
+
"document": "【简易模式】(简易模式/告警模式二选一,分别配置相应参数)\n接口回调信息(包括企业微信、钉钉、飞书)。",
|
3260
3429
|
"example": "无",
|
3261
3430
|
"member": "WebCallback",
|
3262
3431
|
"name": "WebCallbacks",
|
@@ -3265,12 +3434,48 @@
|
|
3265
3434
|
},
|
3266
3435
|
{
|
3267
3436
|
"disabled": false,
|
3268
|
-
"document": "
|
3437
|
+
"document": "【高级模式】(简易模式/告警模式二选一,分别配置相应参数)\n通知规则。",
|
3269
3438
|
"example": "无",
|
3270
3439
|
"member": "NoticeRule",
|
3271
3440
|
"name": "NoticeRules",
|
3272
3441
|
"required": false,
|
3273
3442
|
"type": "list"
|
3443
|
+
},
|
3444
|
+
{
|
3445
|
+
"disabled": false,
|
3446
|
+
"document": "查询数据链接。http:// 或者 https:// 开头,不能/结尾",
|
3447
|
+
"example": "https://console.cloud.tencent.com",
|
3448
|
+
"member": "string",
|
3449
|
+
"name": "JumpDomain",
|
3450
|
+
"required": false,
|
3451
|
+
"type": "string"
|
3452
|
+
},
|
3453
|
+
{
|
3454
|
+
"disabled": false,
|
3455
|
+
"document": "投递日志开关。可取值如下:\n1:关闭(默认值);\n2:开启 \n投递日志开关开启时, DeliverConfig参数必填。",
|
3456
|
+
"example": "2",
|
3457
|
+
"member": "uint64",
|
3458
|
+
"name": "DeliverStatus",
|
3459
|
+
"required": false,
|
3460
|
+
"type": "int"
|
3461
|
+
},
|
3462
|
+
{
|
3463
|
+
"disabled": false,
|
3464
|
+
"document": "投递日志配置参数。当DeliverStatus开启时,必填。",
|
3465
|
+
"example": "无",
|
3466
|
+
"member": "DeliverConfig",
|
3467
|
+
"name": "DeliverConfig",
|
3468
|
+
"required": false,
|
3469
|
+
"type": "object"
|
3470
|
+
},
|
3471
|
+
{
|
3472
|
+
"disabled": false,
|
3473
|
+
"document": "免登录操作告警开关。可取值如下:\n- 1:关闭\n- 2:开启(默认值)",
|
3474
|
+
"example": "1",
|
3475
|
+
"member": "uint64",
|
3476
|
+
"name": "AlarmShieldStatus",
|
3477
|
+
"required": false,
|
3478
|
+
"type": "int"
|
3274
3479
|
}
|
3275
3480
|
],
|
3276
3481
|
"type": "object"
|
@@ -3546,25 +3751,173 @@
|
|
3546
3751
|
},
|
3547
3752
|
{
|
3548
3753
|
"disabled": false,
|
3549
|
-
"document": "屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。",
|
3550
|
-
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-57105ec6-xxxx-xxxx-xxxx-892f3b8d143a\\\"]\",\"Type\":\"Value\"}]}]}",
|
3754
|
+
"document": "屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。",
|
3755
|
+
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-57105ec6-xxxx-xxxx-xxxx-892f3b8d143a\\\"]\",\"Type\":\"Value\"}]}]}",
|
3756
|
+
"member": "string",
|
3757
|
+
"name": "Rule",
|
3758
|
+
"required": false,
|
3759
|
+
"type": "string"
|
3760
|
+
}
|
3761
|
+
],
|
3762
|
+
"type": "object"
|
3763
|
+
},
|
3764
|
+
"CreateAlarmShieldResponse": {
|
3765
|
+
"document": "CreateAlarmShield返回参数结构体",
|
3766
|
+
"members": [
|
3767
|
+
{
|
3768
|
+
"disabled": false,
|
3769
|
+
"document": "屏蔽规则ID。",
|
3770
|
+
"example": "cb37f589-6232-431a-xxxx-e2b61fb375d1",
|
3771
|
+
"member": "string",
|
3772
|
+
"name": "TaskId",
|
3773
|
+
"output_required": true,
|
3774
|
+
"type": "string",
|
3775
|
+
"value_allowed_null": false
|
3776
|
+
},
|
3777
|
+
{
|
3778
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
3779
|
+
"member": "string",
|
3780
|
+
"name": "RequestId",
|
3781
|
+
"type": "string"
|
3782
|
+
}
|
3783
|
+
],
|
3784
|
+
"type": "object"
|
3785
|
+
},
|
3786
|
+
"CreateCloudProductLogTaskRequest": {
|
3787
|
+
"document": "CreateCloudProductLogTask请求参数结构体",
|
3788
|
+
"members": [
|
3789
|
+
{
|
3790
|
+
"disabled": false,
|
3791
|
+
"document": "实例ID",
|
3792
|
+
"example": "ins-r8hr2upy",
|
3793
|
+
"member": "string",
|
3794
|
+
"name": "InstanceId",
|
3795
|
+
"required": true,
|
3796
|
+
"type": "string"
|
3797
|
+
},
|
3798
|
+
{
|
3799
|
+
"disabled": false,
|
3800
|
+
"document": "云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS",
|
3801
|
+
"example": "CDB",
|
3802
|
+
"member": "string",
|
3803
|
+
"name": "AssumerName",
|
3804
|
+
"required": true,
|
3805
|
+
"type": "string"
|
3806
|
+
},
|
3807
|
+
{
|
3808
|
+
"disabled": false,
|
3809
|
+
"document": "日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS",
|
3810
|
+
"example": "CDB-AUDIT",
|
3811
|
+
"member": "string",
|
3812
|
+
"name": "LogType",
|
3813
|
+
"required": true,
|
3814
|
+
"type": "string"
|
3815
|
+
},
|
3816
|
+
{
|
3817
|
+
"disabled": false,
|
3818
|
+
"document": "云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:\n- CDS所有日志类型:ap-guangzhou\n- CDB-AUDIT: gz\n- TDSQL-C-AUDIT: gz\n- MongoDB-AUDIT: gz\n- MongoDB-SlowLog:ap-guangzhou\n- MongoDB-ErrorLog:ap-guangzhou\n- TDMYSQL-SLOW:gz\n- DCDB所有日志类型:gz\n- MariaDB所有日志类型:gz\n- PostgreSQL所有日志类型:gz\n- BH所有日志类型:overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站)\n- APIS所有日志类型:gz",
|
3819
|
+
"example": "ap-guangzhou",
|
3820
|
+
"member": "string",
|
3821
|
+
"name": "CloudProductRegion",
|
3822
|
+
"required": true,
|
3823
|
+
"type": "string"
|
3824
|
+
},
|
3825
|
+
{
|
3826
|
+
"disabled": false,
|
3827
|
+
"document": "CLS目标地域",
|
3828
|
+
"example": "ap-guangzhou",
|
3829
|
+
"member": "string",
|
3830
|
+
"name": "ClsRegion",
|
3831
|
+
"required": true,
|
3832
|
+
"type": "string"
|
3833
|
+
},
|
3834
|
+
{
|
3835
|
+
"disabled": false,
|
3836
|
+
"document": "日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建",
|
3837
|
+
"example": "logset",
|
3838
|
+
"member": "string",
|
3839
|
+
"name": "LogsetName",
|
3840
|
+
"required": false,
|
3841
|
+
"type": "string"
|
3842
|
+
},
|
3843
|
+
{
|
3844
|
+
"disabled": false,
|
3845
|
+
"document": "日志集ID,若指定则代表选择已有日志集。选择已有日志集时,LogsetName可以不填",
|
3846
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
3847
|
+
"member": "string",
|
3848
|
+
"name": "LogsetId",
|
3849
|
+
"required": false,
|
3850
|
+
"type": "string"
|
3851
|
+
},
|
3852
|
+
{
|
3853
|
+
"disabled": false,
|
3854
|
+
"document": "日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建",
|
3855
|
+
"example": "topic",
|
3856
|
+
"member": "string",
|
3857
|
+
"name": "TopicName",
|
3858
|
+
"required": false,
|
3859
|
+
"type": "string"
|
3860
|
+
},
|
3861
|
+
{
|
3862
|
+
"disabled": false,
|
3863
|
+
"document": "日志主题ID,若指定则代表选择已有日志主题,选择已有日志主题时,TopicName可以不填",
|
3864
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
3865
|
+
"member": "string",
|
3866
|
+
"name": "TopicId",
|
3867
|
+
"required": false,
|
3868
|
+
"type": "string"
|
3869
|
+
},
|
3870
|
+
{
|
3871
|
+
"disabled": false,
|
3872
|
+
"document": "日志配置拓展信息, 一般用于存储额外的日志投递配置",
|
3873
|
+
"example": "无",
|
3874
|
+
"member": "string",
|
3875
|
+
"name": "Extend",
|
3876
|
+
"required": false,
|
3877
|
+
"type": "string"
|
3878
|
+
}
|
3879
|
+
],
|
3880
|
+
"type": "object"
|
3881
|
+
},
|
3882
|
+
"CreateCloudProductLogTaskResponse": {
|
3883
|
+
"document": "CreateCloudProductLogTask返回参数结构体",
|
3884
|
+
"members": [
|
3885
|
+
{
|
3886
|
+
"disabled": false,
|
3887
|
+
"document": "日志主题ID",
|
3888
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
3889
|
+
"member": "string",
|
3890
|
+
"name": "TopicId",
|
3891
|
+
"output_required": true,
|
3892
|
+
"type": "string",
|
3893
|
+
"value_allowed_null": false
|
3894
|
+
},
|
3895
|
+
{
|
3896
|
+
"disabled": false,
|
3897
|
+
"document": "日志主题名称",
|
3898
|
+
"example": "test-topic",
|
3899
|
+
"member": "string",
|
3900
|
+
"name": "TopicName",
|
3901
|
+
"output_required": true,
|
3902
|
+
"type": "string",
|
3903
|
+
"value_allowed_null": false
|
3904
|
+
},
|
3905
|
+
{
|
3906
|
+
"disabled": false,
|
3907
|
+
"document": "日志集ID",
|
3908
|
+
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
3551
3909
|
"member": "string",
|
3552
|
-
"name": "
|
3553
|
-
"
|
3554
|
-
"type": "string"
|
3555
|
-
|
3556
|
-
|
3557
|
-
"type": "object"
|
3558
|
-
},
|
3559
|
-
"CreateAlarmShieldResponse": {
|
3560
|
-
"document": "CreateAlarmShield返回参数结构体",
|
3561
|
-
"members": [
|
3910
|
+
"name": "LogsetId",
|
3911
|
+
"output_required": true,
|
3912
|
+
"type": "string",
|
3913
|
+
"value_allowed_null": false
|
3914
|
+
},
|
3562
3915
|
{
|
3563
3916
|
"disabled": false,
|
3564
|
-
"document": "
|
3565
|
-
"example": "
|
3917
|
+
"document": "日志集名称",
|
3918
|
+
"example": "test-logset",
|
3566
3919
|
"member": "string",
|
3567
|
-
"name": "
|
3920
|
+
"name": "LogsetName",
|
3568
3921
|
"output_required": true,
|
3569
3922
|
"type": "string",
|
3570
3923
|
"value_allowed_null": false
|
@@ -4816,8 +5169,8 @@
|
|
4816
5169
|
"members": [
|
4817
5170
|
{
|
4818
5171
|
"disabled": false,
|
4819
|
-
"document": "
|
4820
|
-
"example": "
|
5172
|
+
"document": "模板名称。",
|
5173
|
+
"example": "告警内容模板",
|
4821
5174
|
"member": "string",
|
4822
5175
|
"name": "Name",
|
4823
5176
|
"required": true,
|
@@ -4825,7 +5178,7 @@
|
|
4825
5178
|
},
|
4826
5179
|
{
|
4827
5180
|
"disabled": false,
|
4828
|
-
"document": "
|
5181
|
+
"document": "模板内容语言。0:中文1:英文",
|
4829
5182
|
"example": "0",
|
4830
5183
|
"member": "uint64",
|
4831
5184
|
"name": "Type",
|
@@ -4834,7 +5187,7 @@
|
|
4834
5187
|
},
|
4835
5188
|
{
|
4836
5189
|
"disabled": false,
|
4837
|
-
"document": "
|
5190
|
+
"document": "模板详细配置。",
|
4838
5191
|
"example": "无",
|
4839
5192
|
"member": "NoticeContent",
|
4840
5193
|
"name": "NoticeContents",
|
@@ -5828,6 +6181,26 @@
|
|
5828
6181
|
"output_required": false,
|
5829
6182
|
"type": "int",
|
5830
6183
|
"value_allowed_null": true
|
6184
|
+
},
|
6185
|
+
{
|
6186
|
+
"disabled": false,
|
6187
|
+
"document": "保留失败日志状态。 1:不保留,2:保留\n注意:此字段可能返回 null,表示取不到有效值。",
|
6188
|
+
"example": "1",
|
6189
|
+
"member": "uint64",
|
6190
|
+
"name": "KeepFailureLog",
|
6191
|
+
"output_required": false,
|
6192
|
+
"type": "int",
|
6193
|
+
"value_allowed_null": true
|
6194
|
+
},
|
6195
|
+
{
|
6196
|
+
"disabled": false,
|
6197
|
+
"document": "失败日志的字段名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
6198
|
+
"example": "ETLParseFailure",
|
6199
|
+
"member": "string",
|
6200
|
+
"name": "FailureLogKey",
|
6201
|
+
"output_required": false,
|
6202
|
+
"type": "string",
|
6203
|
+
"value_allowed_null": true
|
5831
6204
|
}
|
5832
6205
|
],
|
5833
6206
|
"usage": "out"
|
@@ -5922,6 +6295,60 @@
|
|
5922
6295
|
],
|
5923
6296
|
"type": "object"
|
5924
6297
|
},
|
6298
|
+
"DeleteCloudProductLogTaskRequest": {
|
6299
|
+
"document": "DeleteCloudProductLogTask请求参数结构体",
|
6300
|
+
"members": [
|
6301
|
+
{
|
6302
|
+
"disabled": false,
|
6303
|
+
"document": "实例ID",
|
6304
|
+
"example": "ins-r8hr2upy",
|
6305
|
+
"member": "string",
|
6306
|
+
"name": "InstanceId",
|
6307
|
+
"required": true,
|
6308
|
+
"type": "string"
|
6309
|
+
},
|
6310
|
+
{
|
6311
|
+
"disabled": false,
|
6312
|
+
"document": "云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS",
|
6313
|
+
"example": "CDB",
|
6314
|
+
"member": "string",
|
6315
|
+
"name": "AssumerName",
|
6316
|
+
"required": true,
|
6317
|
+
"type": "string"
|
6318
|
+
},
|
6319
|
+
{
|
6320
|
+
"disabled": false,
|
6321
|
+
"document": "日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS",
|
6322
|
+
"example": "CDB-AUDIT",
|
6323
|
+
"member": "string",
|
6324
|
+
"name": "LogType",
|
6325
|
+
"required": true,
|
6326
|
+
"type": "string"
|
6327
|
+
},
|
6328
|
+
{
|
6329
|
+
"disabled": false,
|
6330
|
+
"document": "云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:\n- CDS所有日志类型:ap-guangzhou\n- CDB-AUDIT: gz\n- TDSQL-C-AUDIT: gz\n- MongoDB-AUDIT: gz\n- MongoDB-SlowLog:ap-guangzhou\n- MongoDB-ErrorLog:ap-guangzhou\n- TDMYSQL-SLOW:gz\n- DCDB所有日志类型:gz\n- MariaDB所有日志类型:gz\n- PostgreSQL所有日志类型:gz\n- BH所有日志类型:overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站)\n- APIS所有日志类型:gz",
|
6331
|
+
"example": "ap-guangzhou",
|
6332
|
+
"member": "string",
|
6333
|
+
"name": "CloudProductRegion",
|
6334
|
+
"required": true,
|
6335
|
+
"type": "string"
|
6336
|
+
}
|
6337
|
+
],
|
6338
|
+
"type": "object"
|
6339
|
+
},
|
6340
|
+
"DeleteCloudProductLogTaskResponse": {
|
6341
|
+
"document": "DeleteCloudProductLogTask返回参数结构体",
|
6342
|
+
"members": [
|
6343
|
+
{
|
6344
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
6345
|
+
"member": "string",
|
6346
|
+
"name": "RequestId",
|
6347
|
+
"type": "string"
|
6348
|
+
}
|
6349
|
+
],
|
6350
|
+
"type": "object"
|
6351
|
+
},
|
5925
6352
|
"DeleteConfigExtraRequest": {
|
5926
6353
|
"document": "DeleteConfigExtra请求参数结构体",
|
5927
6354
|
"members": [
|
@@ -6305,7 +6732,7 @@
|
|
6305
6732
|
"members": [
|
6306
6733
|
{
|
6307
6734
|
"disabled": false,
|
6308
|
-
"document": "
|
6735
|
+
"document": "通知内容模板ID",
|
6309
6736
|
"example": "noticetemplate-d7286784-46d9-4be3-b7ba-2c464e6a5ad1",
|
6310
6737
|
"member": "string",
|
6311
6738
|
"name": "NoticeContentId",
|
@@ -6417,6 +6844,45 @@
|
|
6417
6844
|
],
|
6418
6845
|
"type": "object"
|
6419
6846
|
},
|
6847
|
+
"DeliverConfig": {
|
6848
|
+
"document": "投递配置入参",
|
6849
|
+
"members": [
|
6850
|
+
{
|
6851
|
+
"disabled": false,
|
6852
|
+
"document": "地域信息。\n\n示例:\n ap-guangzhou 广州地域;\nap-nanjing 南京地域。\n\n详细信息请查看官网:\n\nhttps://cloud.tencent.com/document/product/614/18940",
|
6853
|
+
"example": "ap-guangzhou",
|
6854
|
+
"member": "string",
|
6855
|
+
"name": "Region",
|
6856
|
+
"output_required": true,
|
6857
|
+
"required": true,
|
6858
|
+
"type": "string",
|
6859
|
+
"value_allowed_null": false
|
6860
|
+
},
|
6861
|
+
{
|
6862
|
+
"disabled": false,
|
6863
|
+
"document": "日志主题ID。",
|
6864
|
+
"example": "12312324-asdfa-13513-66254",
|
6865
|
+
"member": "string",
|
6866
|
+
"name": "TopicId",
|
6867
|
+
"output_required": true,
|
6868
|
+
"required": true,
|
6869
|
+
"type": "string",
|
6870
|
+
"value_allowed_null": false
|
6871
|
+
},
|
6872
|
+
{
|
6873
|
+
"disabled": false,
|
6874
|
+
"document": "投递数据范围。\n\n0: 全部日志, 包括告警策略日常周期执行的所有日志,也包括告警策略变更产生的日志,默认值\n\n1:仅告警触发及恢复日志",
|
6875
|
+
"example": "0",
|
6876
|
+
"member": "uint64",
|
6877
|
+
"name": "Scope",
|
6878
|
+
"output_required": true,
|
6879
|
+
"required": true,
|
6880
|
+
"type": "int",
|
6881
|
+
"value_allowed_null": false
|
6882
|
+
}
|
6883
|
+
],
|
6884
|
+
"usage": "both"
|
6885
|
+
},
|
6420
6886
|
"DescribeAlarmNoticesRequest": {
|
6421
6887
|
"document": "DescribeAlarmNotices请求参数结构体",
|
6422
6888
|
"members": [
|
@@ -6702,6 +7168,71 @@
|
|
6702
7168
|
],
|
6703
7169
|
"type": "object"
|
6704
7170
|
},
|
7171
|
+
"DescribeCloudProductLogTasksRequest": {
|
7172
|
+
"document": "DescribeCloudProductLogTasks请求参数结构体",
|
7173
|
+
"members": [
|
7174
|
+
{
|
7175
|
+
"disabled": false,
|
7176
|
+
"document": "分页的偏移量,默认值为0。",
|
7177
|
+
"example": "无",
|
7178
|
+
"member": "int64",
|
7179
|
+
"name": "Offset",
|
7180
|
+
"required": false,
|
7181
|
+
"type": "int"
|
7182
|
+
},
|
7183
|
+
{
|
7184
|
+
"disabled": false,
|
7185
|
+
"document": "分页单页限制数目,默认值为100,最大值100。",
|
7186
|
+
"example": "无",
|
7187
|
+
"member": "int64",
|
7188
|
+
"name": "Limit",
|
7189
|
+
"required": false,
|
7190
|
+
"type": "int"
|
7191
|
+
},
|
7192
|
+
{
|
7193
|
+
"disabled": false,
|
7194
|
+
"document": "- assumerName\n - 按照【云产品标识】进行过滤。\n - 类型:String\n - 必选:否\n - 枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS\n- logType\n - 按照【日志类型】进行过滤。\n - 类型:String\n - 必选:否\n - 枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS\n- instanceId\n - 按照【实例ID】进行过滤。\n - 类型:String\n - 必选:否",
|
7195
|
+
"example": "无",
|
7196
|
+
"member": "Filter",
|
7197
|
+
"name": "Filters",
|
7198
|
+
"required": false,
|
7199
|
+
"type": "list"
|
7200
|
+
}
|
7201
|
+
],
|
7202
|
+
"type": "object"
|
7203
|
+
},
|
7204
|
+
"DescribeCloudProductLogTasksResponse": {
|
7205
|
+
"document": "DescribeCloudProductLogTasks返回参数结构体",
|
7206
|
+
"members": [
|
7207
|
+
{
|
7208
|
+
"disabled": false,
|
7209
|
+
"document": "日志配置详情列表",
|
7210
|
+
"example": "无",
|
7211
|
+
"member": "CloudProductLogTaskInfo",
|
7212
|
+
"name": "Tasks",
|
7213
|
+
"output_required": true,
|
7214
|
+
"type": "list",
|
7215
|
+
"value_allowed_null": false
|
7216
|
+
},
|
7217
|
+
{
|
7218
|
+
"disabled": false,
|
7219
|
+
"document": "日志配置总数",
|
7220
|
+
"example": "1",
|
7221
|
+
"member": "uint64",
|
7222
|
+
"name": "TotalCount",
|
7223
|
+
"output_required": true,
|
7224
|
+
"type": "int",
|
7225
|
+
"value_allowed_null": false
|
7226
|
+
},
|
7227
|
+
{
|
7228
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
7229
|
+
"member": "string",
|
7230
|
+
"name": "RequestId",
|
7231
|
+
"type": "string"
|
7232
|
+
}
|
7233
|
+
],
|
7234
|
+
"type": "object"
|
7235
|
+
},
|
6705
7236
|
"DescribeConfigExtrasRequest": {
|
6706
7237
|
"document": "DescribeConfigExtras请求参数结构体",
|
6707
7238
|
"members": [
|
@@ -6918,7 +7449,7 @@
|
|
6918
7449
|
"example": "true",
|
6919
7450
|
"member": "bool",
|
6920
7451
|
"name": "Effective",
|
6921
|
-
"
|
7452
|
+
"output_required": true,
|
6922
7453
|
"type": "bool",
|
6923
7454
|
"value_allowed_null": false
|
6924
7455
|
},
|
@@ -6928,7 +7459,7 @@
|
|
6928
7459
|
"example": "true",
|
6929
7460
|
"member": "bool",
|
6930
7461
|
"name": "NeedContent",
|
6931
|
-
"
|
7462
|
+
"output_required": true,
|
6932
7463
|
"type": "bool",
|
6933
7464
|
"value_allowed_null": false
|
6934
7465
|
},
|
@@ -6938,7 +7469,7 @@
|
|
6938
7469
|
"example": "无",
|
6939
7470
|
"member": "ConsumerContent",
|
6940
7471
|
"name": "Content",
|
6941
|
-
"
|
7472
|
+
"output_required": true,
|
6942
7473
|
"type": "object",
|
6943
7474
|
"value_allowed_null": true
|
6944
7475
|
},
|
@@ -6948,7 +7479,7 @@
|
|
6948
7479
|
"example": "无",
|
6949
7480
|
"member": "Ckafka",
|
6950
7481
|
"name": "Ckafka",
|
6951
|
-
"
|
7482
|
+
"output_required": true,
|
6952
7483
|
"type": "object",
|
6953
7484
|
"value_allowed_null": false
|
6954
7485
|
},
|
@@ -6958,7 +7489,7 @@
|
|
6958
7489
|
"example": "0",
|
6959
7490
|
"member": "int64",
|
6960
7491
|
"name": "Compression",
|
6961
|
-
"
|
7492
|
+
"output_required": true,
|
6962
7493
|
"type": "int",
|
6963
7494
|
"value_allowed_null": true
|
6964
7495
|
},
|
@@ -8034,7 +8565,7 @@
|
|
8034
8565
|
"members": [
|
8035
8566
|
{
|
8036
8567
|
"disabled": false,
|
8037
|
-
"document": "<li> name\n
|
8568
|
+
"document": "<li> name\n按照【通知内容模板名称】进行过滤。\n类型:String\n必选:否\n</li>\n<li> noticeContentId\n按照【通知内容模板ID】进行过滤。\n类型:String\n必选:否\n</li>\n每次请求的Filters的上限为10,Filter.Values的上限为100。",
|
8038
8569
|
"example": "无",
|
8039
8570
|
"member": "Filter",
|
8040
8571
|
"name": "Filters",
|
@@ -8067,7 +8598,7 @@
|
|
8067
8598
|
"members": [
|
8068
8599
|
{
|
8069
8600
|
"disabled": false,
|
8070
|
-
"document": "
|
8601
|
+
"document": "通知内容模板列表。\n注意:此字段可能返回 null,表示取不到有效值。",
|
8071
8602
|
"example": "无",
|
8072
8603
|
"member": "NoticeContentTemplate",
|
8073
8604
|
"name": "NoticeContents",
|
@@ -8077,7 +8608,7 @@
|
|
8077
8608
|
},
|
8078
8609
|
{
|
8079
8610
|
"disabled": false,
|
8080
|
-
"document": "
|
8611
|
+
"document": "符合条件的通知内容模板总数。",
|
8081
8612
|
"example": "0",
|
8082
8613
|
"member": "int64",
|
8083
8614
|
"name": "TotalCount",
|
@@ -8274,7 +8805,7 @@
|
|
8274
8805
|
"members": [
|
8275
8806
|
{
|
8276
8807
|
"disabled": false,
|
8277
|
-
"document": "- shipperName
|
8808
|
+
"document": "- shipperName:按照【投递规则名称】进行过滤。\n 类型:String。\n 必选:否\n- shipperId:按照【投递规则ID】进行过滤。\n 类型:String。\n 必选:否\n- topicId:按照【日志主题】进行过滤。\n 类型:String。\n 必选:否\n- taskStatus\n按照【任务运行状态】进行过滤。 支持`0`:停止,`1`:运行中,`2`:异常\n类型:String\n必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为10。",
|
8278
8809
|
"example": "无",
|
8279
8810
|
"member": "Filter",
|
8280
8811
|
"name": "Filters",
|
@@ -8415,29 +8946,101 @@
|
|
8415
8946
|
"name": "TotalCount",
|
8416
8947
|
"output_required": true,
|
8417
8948
|
"type": "int",
|
8418
|
-
"value_allowed_null": false
|
8949
|
+
"value_allowed_null": false
|
8950
|
+
},
|
8951
|
+
{
|
8952
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
8953
|
+
"member": "string",
|
8954
|
+
"name": "RequestId",
|
8955
|
+
"type": "string"
|
8956
|
+
}
|
8957
|
+
],
|
8958
|
+
"type": "object"
|
8959
|
+
},
|
8960
|
+
"DynamicIndex": {
|
8961
|
+
"document": "键值索引自动配置,启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。",
|
8962
|
+
"members": [
|
8963
|
+
{
|
8964
|
+
"disabled": false,
|
8965
|
+
"document": "键值索引自动配置开关\n注意:此字段可能返回 null,表示取不到有效值。",
|
8966
|
+
"example": "false",
|
8967
|
+
"member": "bool",
|
8968
|
+
"name": "Status",
|
8969
|
+
"output_required": true,
|
8970
|
+
"required": false,
|
8971
|
+
"type": "bool",
|
8972
|
+
"value_allowed_null": true
|
8973
|
+
}
|
8974
|
+
],
|
8975
|
+
"usage": "both"
|
8976
|
+
},
|
8977
|
+
"EscalateNoticeInfo": {
|
8978
|
+
"document": "升级通知",
|
8979
|
+
"members": [
|
8980
|
+
{
|
8981
|
+
"disabled": false,
|
8982
|
+
"document": "告警通知模板接收者信息。",
|
8983
|
+
"example": "无",
|
8984
|
+
"member": "NoticeReceiver",
|
8985
|
+
"name": "NoticeReceivers",
|
8986
|
+
"output_required": false,
|
8987
|
+
"required": true,
|
8988
|
+
"type": "list",
|
8989
|
+
"value_allowed_null": false
|
8990
|
+
},
|
8991
|
+
{
|
8992
|
+
"disabled": false,
|
8993
|
+
"document": "告警通知模板回调信息。",
|
8994
|
+
"example": "无",
|
8995
|
+
"member": "WebCallback",
|
8996
|
+
"name": "WebCallbacks",
|
8997
|
+
"output_required": false,
|
8998
|
+
"required": true,
|
8999
|
+
"type": "list",
|
9000
|
+
"value_allowed_null": false
|
9001
|
+
},
|
9002
|
+
{
|
9003
|
+
"disabled": false,
|
9004
|
+
"document": "告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false\n注意:此字段可能返回 null,表示取不到有效值。",
|
9005
|
+
"example": "false",
|
9006
|
+
"member": "bool",
|
9007
|
+
"name": "Escalate",
|
9008
|
+
"output_required": false,
|
9009
|
+
"required": false,
|
9010
|
+
"type": "bool",
|
9011
|
+
"value_allowed_null": true
|
9012
|
+
},
|
9013
|
+
{
|
9014
|
+
"disabled": false,
|
9015
|
+
"document": "告警升级间隔。单位:分钟,范围`[1,14400]`\n注意:此字段可能返回 null,表示取不到有效值。",
|
9016
|
+
"example": "5",
|
9017
|
+
"member": "uint64",
|
9018
|
+
"name": "Interval",
|
9019
|
+
"output_required": false,
|
9020
|
+
"required": false,
|
9021
|
+
"type": "int",
|
9022
|
+
"value_allowed_null": true
|
9023
|
+
},
|
9024
|
+
{
|
9025
|
+
"disabled": false,
|
9026
|
+
"document": "升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1\n- 无人认领且未恢复:告警没有恢复并且没有人认领则升级\n- 未恢复:当前告警持续未恢复则升级\n\n注意:此字段可能返回 null,表示取不到有效值。",
|
9027
|
+
"example": "1",
|
9028
|
+
"member": "uint64",
|
9029
|
+
"name": "Type",
|
9030
|
+
"output_required": false,
|
9031
|
+
"required": false,
|
9032
|
+
"type": "int",
|
9033
|
+
"value_allowed_null": true
|
8419
9034
|
},
|
8420
|
-
{
|
8421
|
-
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
8422
|
-
"member": "string",
|
8423
|
-
"name": "RequestId",
|
8424
|
-
"type": "string"
|
8425
|
-
}
|
8426
|
-
],
|
8427
|
-
"type": "object"
|
8428
|
-
},
|
8429
|
-
"DynamicIndex": {
|
8430
|
-
"document": "键值索引自动配置,启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。",
|
8431
|
-
"members": [
|
8432
9035
|
{
|
8433
9036
|
"disabled": false,
|
8434
|
-
"document": "
|
8435
|
-
"example": "
|
8436
|
-
"member": "
|
8437
|
-
"name": "
|
8438
|
-
"output_required":
|
9037
|
+
"document": "告警升级后下一个环节的通知渠道配置,最多可配置5个环节。\n注意:此字段可能返回 null,表示取不到有效值。",
|
9038
|
+
"example": "无",
|
9039
|
+
"member": "EscalateNoticeInfo",
|
9040
|
+
"name": "EscalateNotice",
|
9041
|
+
"output_required": false,
|
8439
9042
|
"required": false,
|
8440
|
-
"type": "
|
9043
|
+
"type": "object",
|
8441
9044
|
"value_allowed_null": true
|
8442
9045
|
}
|
8443
9046
|
],
|
@@ -10509,6 +11112,15 @@
|
|
10509
11112
|
"required": true,
|
10510
11113
|
"type": "string"
|
10511
11114
|
},
|
11115
|
+
{
|
11116
|
+
"disabled": false,
|
11117
|
+
"document": "标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对,并且不能有重复的键值对。",
|
11118
|
+
"example": "无",
|
11119
|
+
"member": "Tag",
|
11120
|
+
"name": "Tags",
|
11121
|
+
"required": false,
|
11122
|
+
"type": "list"
|
11123
|
+
},
|
10512
11124
|
{
|
10513
11125
|
"disabled": false,
|
10514
11126
|
"document": "通知渠道组名称。",
|
@@ -10538,7 +11150,7 @@
|
|
10538
11150
|
},
|
10539
11151
|
{
|
10540
11152
|
"disabled": false,
|
10541
|
-
"document": "
|
11153
|
+
"document": "接口回调信息(包括企业微信等)。",
|
10542
11154
|
"example": "无",
|
10543
11155
|
"member": "WebCallback",
|
10544
11156
|
"name": "WebCallbacks",
|
@@ -10553,6 +11165,42 @@
|
|
10553
11165
|
"name": "NoticeRules",
|
10554
11166
|
"required": false,
|
10555
11167
|
"type": "list"
|
11168
|
+
},
|
11169
|
+
{
|
11170
|
+
"disabled": false,
|
11171
|
+
"document": "调用链接域名。http:// 或者 https:// 开头,不能/结尾",
|
11172
|
+
"example": "https://console.cloud.tencent.com",
|
11173
|
+
"member": "string",
|
11174
|
+
"name": "JumpDomain",
|
11175
|
+
"required": false,
|
11176
|
+
"type": "string"
|
11177
|
+
},
|
11178
|
+
{
|
11179
|
+
"disabled": false,
|
11180
|
+
"document": "投递日志开关。\n\n参数值:\n1:关闭;\n\n2:开启 \n",
|
11181
|
+
"example": "2",
|
11182
|
+
"member": "uint64",
|
11183
|
+
"name": "DeliverStatus",
|
11184
|
+
"required": false,
|
11185
|
+
"type": "int"
|
11186
|
+
},
|
11187
|
+
{
|
11188
|
+
"disabled": false,
|
11189
|
+
"document": "投递日志配置。",
|
11190
|
+
"example": "无",
|
11191
|
+
"member": "DeliverConfig",
|
11192
|
+
"name": "DeliverConfig",
|
11193
|
+
"required": false,
|
11194
|
+
"type": "object"
|
11195
|
+
},
|
11196
|
+
{
|
11197
|
+
"disabled": false,
|
11198
|
+
"document": "免登录操作告警开关。\n\n参数值: \n 1:关闭\n 2:开启(默认开启)",
|
11199
|
+
"example": "无",
|
11200
|
+
"member": "uint64",
|
11201
|
+
"name": "AlarmShieldStatus",
|
11202
|
+
"required": false,
|
11203
|
+
"type": "int"
|
10556
11204
|
}
|
10557
11205
|
],
|
10558
11206
|
"type": "object"
|
@@ -10857,6 +11505,69 @@
|
|
10857
11505
|
],
|
10858
11506
|
"type": "object"
|
10859
11507
|
},
|
11508
|
+
"ModifyCloudProductLogTaskRequest": {
|
11509
|
+
"document": "ModifyCloudProductLogTask请求参数结构体",
|
11510
|
+
"members": [
|
11511
|
+
{
|
11512
|
+
"disabled": false,
|
11513
|
+
"document": "实例ID",
|
11514
|
+
"example": "ins-r8hr2upy",
|
11515
|
+
"member": "string",
|
11516
|
+
"name": "InstanceId",
|
11517
|
+
"required": true,
|
11518
|
+
"type": "string"
|
11519
|
+
},
|
11520
|
+
{
|
11521
|
+
"disabled": false,
|
11522
|
+
"document": "云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS",
|
11523
|
+
"example": "CDB",
|
11524
|
+
"member": "string",
|
11525
|
+
"name": "AssumerName",
|
11526
|
+
"required": true,
|
11527
|
+
"type": "string"
|
11528
|
+
},
|
11529
|
+
{
|
11530
|
+
"disabled": false,
|
11531
|
+
"document": "日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS",
|
11532
|
+
"example": "CDB-AUDIT",
|
11533
|
+
"member": "string",
|
11534
|
+
"name": "LogType",
|
11535
|
+
"required": true,
|
11536
|
+
"type": "string"
|
11537
|
+
},
|
11538
|
+
{
|
11539
|
+
"disabled": false,
|
11540
|
+
"document": "云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:\n- CDS所有日志类型:ap-guangzhou\n- CDB-AUDIT: gz\n- TDSQL-C-AUDIT: gz\n- MongoDB-AUDIT: gz\n- MongoDB-SlowLog:ap-guangzhou\n- MongoDB-ErrorLog:ap-guangzhou\n- TDMYSQL-SLOW:gz\n- DCDB所有日志类型:gz\n- MariaDB所有日志类型:gz\n- PostgreSQL所有日志类型:gz\n- BH所有日志类型:overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站)\n- APIS所有日志类型:gz",
|
11541
|
+
"example": "ap-guangzhou",
|
11542
|
+
"member": "string",
|
11543
|
+
"name": "CloudProductRegion",
|
11544
|
+
"required": true,
|
11545
|
+
"type": "string"
|
11546
|
+
},
|
11547
|
+
{
|
11548
|
+
"disabled": false,
|
11549
|
+
"document": "日志配置拓展信息, 一般用于存储额外的日志投递配置",
|
11550
|
+
"example": "无",
|
11551
|
+
"member": "string",
|
11552
|
+
"name": "Extend",
|
11553
|
+
"required": false,
|
11554
|
+
"type": "string"
|
11555
|
+
}
|
11556
|
+
],
|
11557
|
+
"type": "object"
|
11558
|
+
},
|
11559
|
+
"ModifyCloudProductLogTaskResponse": {
|
11560
|
+
"document": "ModifyCloudProductLogTask返回参数结构体",
|
11561
|
+
"members": [
|
11562
|
+
{
|
11563
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
11564
|
+
"member": "string",
|
11565
|
+
"name": "RequestId",
|
11566
|
+
"type": "string"
|
11567
|
+
}
|
11568
|
+
],
|
11569
|
+
"type": "object"
|
11570
|
+
},
|
10860
11571
|
"ModifyConfigExtraRequest": {
|
10861
11572
|
"document": "ModifyConfigExtra请求参数结构体",
|
10862
11573
|
"members": [
|
@@ -11897,7 +12608,7 @@
|
|
11897
12608
|
"members": [
|
11898
12609
|
{
|
11899
12610
|
"disabled": false,
|
11900
|
-
"document": "
|
12611
|
+
"document": "通知内容模板ID。",
|
11901
12612
|
"example": "noticetemplate-5b2ea996-4dae-47cc-bbad-5b12888b4c89",
|
11902
12613
|
"member": "string",
|
11903
12614
|
"name": "NoticeContentId",
|
@@ -11906,7 +12617,7 @@
|
|
11906
12617
|
},
|
11907
12618
|
{
|
11908
12619
|
"disabled": false,
|
11909
|
-
"document": "
|
12620
|
+
"document": "通知内容模板名称。",
|
11910
12621
|
"example": "test",
|
11911
12622
|
"member": "string",
|
11912
12623
|
"name": "Name",
|
@@ -11924,7 +12635,7 @@
|
|
11924
12635
|
},
|
11925
12636
|
{
|
11926
12637
|
"disabled": false,
|
11927
|
-
"document": "
|
12638
|
+
"document": "通知内容模板详细信息。",
|
11928
12639
|
"example": "无",
|
11929
12640
|
"member": "NoticeContent",
|
11930
12641
|
"name": "NoticeContents",
|
@@ -12427,7 +13138,7 @@
|
|
12427
13138
|
"usage": "in"
|
12428
13139
|
},
|
12429
13140
|
"NoticeContent": {
|
12430
|
-
"document": "
|
13141
|
+
"document": "通知内容模板详细配置",
|
12431
13142
|
"members": [
|
12432
13143
|
{
|
12433
13144
|
"disabled": false,
|
@@ -12442,7 +13153,7 @@
|
|
12442
13153
|
},
|
12443
13154
|
{
|
12444
13155
|
"disabled": false,
|
12445
|
-
"document": "
|
13156
|
+
"document": "告警触发通知内容模板。\n注意:此字段可能返回 null,表示取不到有效值。",
|
12446
13157
|
"example": "无",
|
12447
13158
|
"member": "NoticeContentInfo",
|
12448
13159
|
"name": "TriggerContent",
|
@@ -12453,7 +13164,7 @@
|
|
12453
13164
|
},
|
12454
13165
|
{
|
12455
13166
|
"disabled": false,
|
12456
|
-
"document": "
|
13167
|
+
"document": "告警恢复通知内容模板。\n注意:此字段可能返回 null,表示取不到有效值。",
|
12457
13168
|
"example": "无",
|
12458
13169
|
"member": "NoticeContentInfo",
|
12459
13170
|
"name": "RecoveryContent",
|
@@ -12638,8 +13349,19 @@
|
|
12638
13349
|
},
|
12639
13350
|
{
|
12640
13351
|
"disabled": false,
|
12641
|
-
"document": "
|
12642
|
-
"example": "
|
13352
|
+
"document": "通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。\n注意:此字段可能返回 null,表示取不到有效值。",
|
13353
|
+
"example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"",
|
13354
|
+
"member": "string",
|
13355
|
+
"name": "NoticeContentId",
|
13356
|
+
"output_required": false,
|
13357
|
+
"required": false,
|
13358
|
+
"type": "string",
|
13359
|
+
"value_allowed_null": true
|
13360
|
+
},
|
13361
|
+
{
|
13362
|
+
"disabled": false,
|
13363
|
+
"document": "允许接收信息的开始时间。格式:`15:04:05`。必填",
|
13364
|
+
"example": "00:00:00",
|
12643
13365
|
"member": "string",
|
12644
13366
|
"name": "StartTime",
|
12645
13367
|
"output_required": true,
|
@@ -12649,8 +13371,8 @@
|
|
12649
13371
|
},
|
12650
13372
|
{
|
12651
13373
|
"disabled": false,
|
12652
|
-
"document": "允许接收信息的结束时间。格式:`15:04:05
|
12653
|
-
"example": "
|
13374
|
+
"document": "允许接收信息的结束时间。格式:`15:04:05`。必填",
|
13375
|
+
"example": "23:59:59",
|
12654
13376
|
"member": "string",
|
12655
13377
|
"name": "EndTime",
|
12656
13378
|
"output_required": true,
|
@@ -12668,17 +13390,6 @@
|
|
12668
13390
|
"required": false,
|
12669
13391
|
"type": "int",
|
12670
13392
|
"value_allowed_null": false
|
12671
|
-
},
|
12672
|
-
{
|
12673
|
-
"disabled": false,
|
12674
|
-
"document": "通知内容模板ID。\n注意:此字段可能返回 null,表示取不到有效值。",
|
12675
|
-
"example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"",
|
12676
|
-
"member": "string",
|
12677
|
-
"name": "NoticeContentId",
|
12678
|
-
"output_required": false,
|
12679
|
-
"required": false,
|
12680
|
-
"type": "string",
|
12681
|
-
"value_allowed_null": true
|
12682
13393
|
}
|
12683
13394
|
],
|
12684
13395
|
"usage": "both"
|
@@ -12688,7 +13399,18 @@
|
|
12688
13399
|
"members": [
|
12689
13400
|
{
|
12690
13401
|
"disabled": false,
|
12691
|
-
"document": "
|
13402
|
+
"document": "匹配规则 JSON串。\n**rule规则树格式为嵌套结构体JSON字符串**\n`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,0]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}`\n\n**rule规则树限制规则如下**:\n- 顶层rule中Type可取值:`Condition`,`Operation`\n- Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`\n- Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`\n- 其他Type无子节点\n- 当rule Type为`Operation`时,value可取值:`AND`,`OR`\n- 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2\n - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`\n - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组\n - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式\n - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组\n\n**业务参数含义**:\n- Type:Condition 表示是规则条件,Value:Level 表示告警等级\n - 子节点Type支持`Compare`,Value支持`In`,`NotIn`\n - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)\n以下示例表示:告警等级属于提醒\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Level\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}`\n\n- Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型\n - 子节点Type支持`Compare`,Value支持`In`,`NotIn`\n - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)\n以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1]\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"NotIn\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[2]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}]}`\n\n- Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略\n - 子节点Type支持`Compare`,Value支持`In`,`NotIn`\n - 下一个子节点value支持的值:告警策略id数组\n以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx\n`\"{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"AlarmID\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\\\\\",\\\\\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"AlarmID\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"NotIn\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}]}\"`\n\n- Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称\n - 子节点Type支持`Compare`,Value支持`=~`,`!=~`\n - 下一个子节点value支持的值:必须是正则表达式\n以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"AlarmName\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"=~\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"^test$\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"AlarmName\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"!=~\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"^hahaha$\\\",\\\"Type\\\":\\\"Value\\\"}]}]}]}`\n\n- Type:Condition 表示是规则条件,Value:Label 表示告警分类字段\n - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`\n - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式\n以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Label\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"key1\\\",\\\"Type\\\":\\\"Key\\\"},{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"v1\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Label\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"key2\\\",\\\"Type\\\":\\\"Key\\\"},{\\\"Value\\\":\\\"NotIn\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"v2\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Label\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"key3\\\",\\\"Type\\\":\\\"Key\\\"},{\\\"Value\\\":\\\"=~\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"^test$\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Label\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"key4\\\",\\\"Type\\\":\\\"Key\\\"},{\\\"Value\\\":\\\"!=~\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"^hahaha$\\\",\\\"Type\\\":\\\"Value\\\"}]}]}]}`\n\n- Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间\n - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `\n - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组\n以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyTime\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"Between\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"14:18:36\\\\\\\",\\\\\\\"14:33:36\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyTime\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"NotBetween\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[\\\\\\\"14:20:36\\\\\\\",\\\\\\\"14:30:36\\\\\\\"]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}]}`\n\n- Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间\n - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`\n - 下一个子节点value支持的值:整型值单位分钟\n以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟\n`{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"OR\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Duration\\\",\\\"Children\\\":[{\\\"Value\\\":\\\">\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":1,\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Duration\\\",\\\"Children\\\":[{\\\"Value\\\":\\\">=\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":2,\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Duration\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"<\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":3,\\\"Type\\\":\\\"Value\\\"}]},{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"Duration\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"<=\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":4,\\\"Type\\\":\\\"Value\\\"}]}]}]}`\n注意:此字段可能返回 null,表示取不到有效值。",
|
13403
|
+
"example": "{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1,2]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}",
|
13404
|
+
"member": "string",
|
13405
|
+
"name": "Rule",
|
13406
|
+
"output_required": false,
|
13407
|
+
"required": false,
|
13408
|
+
"type": "string",
|
13409
|
+
"value_allowed_null": true
|
13410
|
+
},
|
13411
|
+
{
|
13412
|
+
"disabled": false,
|
13413
|
+
"document": "告警通知接收者信息。\n注意:此字段可能返回 null,表示取不到有效值。",
|
12692
13414
|
"example": "无",
|
12693
13415
|
"member": "NoticeReceiver",
|
12694
13416
|
"name": "NoticeReceivers",
|
@@ -12699,7 +13421,7 @@
|
|
12699
13421
|
},
|
12700
13422
|
{
|
12701
13423
|
"disabled": false,
|
12702
|
-
"document": "
|
13424
|
+
"document": "告警通知模板回调信息,包括企业微信、钉钉、飞书。\n注意:此字段可能返回 null,表示取不到有效值。",
|
12703
13425
|
"example": "无",
|
12704
13426
|
"member": "WebCallback",
|
12705
13427
|
"name": "WebCallbacks",
|
@@ -12710,13 +13432,46 @@
|
|
12710
13432
|
},
|
12711
13433
|
{
|
12712
13434
|
"disabled": false,
|
12713
|
-
"document": "
|
12714
|
-
"example": "
|
12715
|
-
"member": "
|
12716
|
-
"name": "
|
13435
|
+
"document": "告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false\n注意:此字段可能返回 null,表示取不到有效值。",
|
13436
|
+
"example": "false",
|
13437
|
+
"member": "bool",
|
13438
|
+
"name": "Escalate",
|
12717
13439
|
"output_required": false,
|
12718
13440
|
"required": false,
|
12719
|
-
"type": "
|
13441
|
+
"type": "bool",
|
13442
|
+
"value_allowed_null": true
|
13443
|
+
},
|
13444
|
+
{
|
13445
|
+
"disabled": false,
|
13446
|
+
"document": "告警升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1\n- 无人认领且未恢复:告警没有恢复并且没有人认领则升级\n- 未恢复:当前告警持续未恢复则升级\n\n注意:此字段可能返回 null,表示取不到有效值。",
|
13447
|
+
"example": "1",
|
13448
|
+
"member": "uint64",
|
13449
|
+
"name": "Type",
|
13450
|
+
"output_required": false,
|
13451
|
+
"required": false,
|
13452
|
+
"type": "int",
|
13453
|
+
"value_allowed_null": true
|
13454
|
+
},
|
13455
|
+
{
|
13456
|
+
"disabled": false,
|
13457
|
+
"document": "告警升级间隔。单位:分钟,范围`[1,14400]`\n注意:此字段可能返回 null,表示取不到有效值。",
|
13458
|
+
"example": "1",
|
13459
|
+
"member": "uint64",
|
13460
|
+
"name": "Interval",
|
13461
|
+
"output_required": false,
|
13462
|
+
"required": false,
|
13463
|
+
"type": "int",
|
13464
|
+
"value_allowed_null": true
|
13465
|
+
},
|
13466
|
+
{
|
13467
|
+
"disabled": false,
|
13468
|
+
"document": "告警升级后下一个环节的通知渠道配置\n注意:此字段可能返回 null,表示取不到有效值。",
|
13469
|
+
"example": "无",
|
13470
|
+
"member": "EscalateNoticeInfo",
|
13471
|
+
"name": "EscalateNotice",
|
13472
|
+
"output_required": false,
|
13473
|
+
"required": false,
|
13474
|
+
"type": "object",
|
12720
13475
|
"value_allowed_null": true
|
12721
13476
|
}
|
12722
13477
|
],
|
@@ -14935,10 +15690,10 @@
|
|
14935
15690
|
"members": [
|
14936
15691
|
{
|
14937
15692
|
"disabled": false,
|
14938
|
-
"document": "
|
14939
|
-
"example": "
|
15693
|
+
"document": "回调的类型。可选值:\n- Http\n- WeCom\n- DingTalk\n- Lark",
|
15694
|
+
"example": "WeCom",
|
14940
15695
|
"member": "string",
|
14941
|
-
"name": "
|
15696
|
+
"name": "CallbackType",
|
14942
15697
|
"output_required": true,
|
14943
15698
|
"required": true,
|
14944
15699
|
"type": "string",
|
@@ -14946,10 +15701,10 @@
|
|
14946
15701
|
},
|
14947
15702
|
{
|
14948
15703
|
"disabled": false,
|
14949
|
-
"document": "
|
14950
|
-
"example": "
|
15704
|
+
"document": "回调地址,最大支持1024个字节。\n也可使用WebCallbackId引用集成配置中的URL,此时该字段请填写为空字符串。",
|
15705
|
+
"example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=4c3cf1e0-a6e7-47f4-b264-5d2kjnbhjgx",
|
14951
15706
|
"member": "string",
|
14952
|
-
"name": "
|
15707
|
+
"name": "Url",
|
14953
15708
|
"output_required": true,
|
14954
15709
|
"required": true,
|
14955
15710
|
"type": "string",
|
@@ -14957,69 +15712,102 @@
|
|
14957
15712
|
},
|
14958
15713
|
{
|
14959
15714
|
"disabled": false,
|
14960
|
-
"document": "
|
14961
|
-
"example": "
|
15715
|
+
"document": "集成配置ID。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15716
|
+
"example": "\"webcallback-aaa-bbb-ccc-ddd\"",
|
14962
15717
|
"member": "string",
|
14963
|
-
"name": "
|
14964
|
-
"output_required":
|
15718
|
+
"name": "WebCallbackId",
|
15719
|
+
"output_required": false,
|
14965
15720
|
"required": false,
|
14966
15721
|
"type": "string",
|
14967
15722
|
"value_allowed_null": true
|
14968
15723
|
},
|
14969
15724
|
{
|
14970
15725
|
"disabled": false,
|
14971
|
-
"document": "
|
14972
|
-
"example": "
|
15726
|
+
"document": "回调方法。可选值:\n- POST(默认值)\n- PUT\n\n注意:\n- 参数CallbackType为Http时为必选,其它回调方式无需填写。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15727
|
+
"example": "POST",
|
14973
15728
|
"member": "string",
|
14974
|
-
"name": "
|
15729
|
+
"name": "Method",
|
14975
15730
|
"output_required": true,
|
14976
15731
|
"required": false,
|
14977
|
-
"type": "
|
15732
|
+
"type": "string",
|
14978
15733
|
"value_allowed_null": true
|
14979
15734
|
},
|
14980
15735
|
{
|
14981
15736
|
"disabled": false,
|
14982
|
-
"document": "
|
14983
|
-
"example": "
|
15737
|
+
"document": "通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15738
|
+
"example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"",
|
14984
15739
|
"member": "string",
|
14985
|
-
"name": "
|
14986
|
-
"output_required":
|
15740
|
+
"name": "NoticeContentId",
|
15741
|
+
"output_required": false,
|
14987
15742
|
"required": false,
|
14988
15743
|
"type": "string",
|
14989
15744
|
"value_allowed_null": true
|
14990
15745
|
},
|
14991
15746
|
{
|
14992
15747
|
"disabled": false,
|
14993
|
-
"document": "
|
14994
|
-
"example": "
|
14995
|
-
"member": "
|
14996
|
-
"name": "
|
14997
|
-
"output_required":
|
15748
|
+
"document": "提醒类型。\n\n0:不提醒;1:指定人;2:所有人\n注意:此字段可能返回 null,表示取不到有效值。",
|
15749
|
+
"example": "无",
|
15750
|
+
"member": "uint64",
|
15751
|
+
"name": "RemindType",
|
15752
|
+
"output_required": false,
|
14998
15753
|
"required": false,
|
14999
15754
|
"type": "int",
|
15000
|
-
"value_allowed_null":
|
15755
|
+
"value_allowed_null": true
|
15001
15756
|
},
|
15002
15757
|
{
|
15003
15758
|
"disabled": false,
|
15004
|
-
"document": "
|
15005
|
-
"example": "
|
15759
|
+
"document": "电话列表。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15760
|
+
"example": "无",
|
15006
15761
|
"member": "string",
|
15007
|
-
"name": "
|
15762
|
+
"name": "Mobiles",
|
15008
15763
|
"output_required": false,
|
15009
15764
|
"required": false,
|
15010
|
-
"type": "
|
15765
|
+
"type": "list",
|
15011
15766
|
"value_allowed_null": true
|
15012
15767
|
},
|
15013
15768
|
{
|
15014
15769
|
"disabled": false,
|
15015
|
-
"document": "
|
15016
|
-
"example": "
|
15770
|
+
"document": "用户ID列表。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15771
|
+
"example": "无",
|
15017
15772
|
"member": "string",
|
15018
|
-
"name": "
|
15773
|
+
"name": "UserIds",
|
15019
15774
|
"output_required": false,
|
15020
15775
|
"required": false,
|
15776
|
+
"type": "list",
|
15777
|
+
"value_allowed_null": true
|
15778
|
+
},
|
15779
|
+
{
|
15780
|
+
"disabled": false,
|
15781
|
+
"document": "该参数已废弃,请使用NoticeContentId。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15782
|
+
"example": "无",
|
15783
|
+
"member": "string",
|
15784
|
+
"name": "Headers",
|
15785
|
+
"output_required": true,
|
15786
|
+
"required": false,
|
15787
|
+
"type": "list",
|
15788
|
+
"value_allowed_null": true
|
15789
|
+
},
|
15790
|
+
{
|
15791
|
+
"disabled": false,
|
15792
|
+
"document": "该参数已废弃,请使用NoticeContentId。\n注意:此字段可能返回 null,表示取不到有效值。",
|
15793
|
+
"example": "无",
|
15794
|
+
"member": "string",
|
15795
|
+
"name": "Body",
|
15796
|
+
"output_required": true,
|
15797
|
+
"required": false,
|
15021
15798
|
"type": "string",
|
15022
15799
|
"value_allowed_null": true
|
15800
|
+
},
|
15801
|
+
{
|
15802
|
+
"disabled": false,
|
15803
|
+
"document": "序号。\n- 入参无效。\n- 出参有效。",
|
15804
|
+
"example": "1",
|
15805
|
+
"member": "int64",
|
15806
|
+
"name": "Index",
|
15807
|
+
"output_required": true,
|
15808
|
+
"required": false,
|
15809
|
+
"type": "int",
|
15810
|
+
"value_allowed_null": false
|
15023
15811
|
}
|
15024
15812
|
],
|
15025
15813
|
"usage": "both"
|