tccli 3.0.1100.1__py2.py3-none-any.whl → 3.0.1102.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/examples/cdb/v20170320/CloseSSL.md +21 -0
  3. tccli/examples/cdb/v20170320/DescribeSSLStatus.md +22 -0
  4. tccli/examples/cdb/v20170320/OpenSSL.md +21 -0
  5. tccli/examples/cls/v20201016/DeleteConfigExtra.md +1 -1
  6. tccli/examples/cls/v20201016/DeleteDataTransform.md +1 -1
  7. tccli/examples/cls/v20201016/ModifyConfigExtra.md +2 -2
  8. tccli/examples/csip/v20221121/CreateRiskCenterScanTask.md +1 -0
  9. tccli/examples/csip/v20221121/DescribeRiskCenterAssetViewCFGRiskList.md +1 -0
  10. tccli/examples/csip/v20221121/DescribeRiskCenterAssetViewPortRiskList.md +1 -0
  11. tccli/examples/csip/v20221121/DescribeRiskCenterAssetViewVULRiskList.md +1 -0
  12. tccli/examples/csip/v20221121/DescribeRiskCenterAssetViewWeakPasswordRiskList.md +1 -0
  13. tccli/examples/csip/v20221121/DescribeRiskCenterPortViewPortRiskList.md +1 -0
  14. tccli/examples/csip/v20221121/DescribeRiskCenterServerRiskList.md +1 -0
  15. tccli/examples/csip/v20221121/DescribeRiskCenterVULViewVULRiskList.md +1 -0
  16. tccli/examples/csip/v20221121/DescribeRiskCenterWebsiteRiskList.md +1 -0
  17. tccli/examples/csip/v20221121/DescribeScanTaskList.md +1 -0
  18. tccli/examples/csip/v20221121/DescribeTaskLogURL.md +1 -0
  19. tccli/examples/csip/v20221121/ModifyRiskCenterRiskStatus.md +1 -0
  20. tccli/examples/csip/v20221121/ModifyRiskCenterScanTask.md +1 -0
  21. tccli/examples/postgres/v20170312/ModifyAccountRemark.md +1 -1
  22. tccli/examples/rum/v20210622/DescribeError.md +1 -1
  23. tccli/examples/rum/v20210622/ModifyProject.md +1 -1
  24. tccli/examples/teo/v20220901/DescribeRulesSetting.md +6 -159
  25. tccli/examples/teo/v20220901/DescribeSecurityIPGroup.md +30 -0
  26. tccli/examples/trtc/v20190722/CreateCloudRecording.md +2 -2
  27. tccli/examples/tsf/v20180326/CreateCluster.md +2 -2
  28. tccli/examples/vpc/v20170312/DeleteVpnGateway.md +1 -2
  29. tccli/examples/vpc/v20170312/DescribeVpnGatewaySslServers.md +23 -33
  30. tccli/examples/vpc/v20170312/InquiryPriceCreateVpnGateway.md +11 -3
  31. tccli/examples/vpc/v20170312/InquiryPriceResetVpnGatewayInternetMaxBandwidth.md +14 -7
  32. tccli/examples/vpc/v20170312/ModifyVpnGatewayCcnRoutes.md +1 -1
  33. tccli/examples/wedata/v20210820/DescribeProject.md +58 -1
  34. tccli/services/cdb/cdb_client.py +163 -4
  35. tccli/services/cdb/v20170320/api.json +169 -0
  36. tccli/services/cdb/v20170320/examples.json +24 -0
  37. tccli/services/cdn/v20180606/api.json +1 -1
  38. tccli/services/clb/v20180317/api.json +18 -0
  39. tccli/services/cls/v20201016/api.json +97 -75
  40. tccli/services/cls/v20201016/examples.json +3 -3
  41. tccli/services/csip/v20221121/api.json +157 -4
  42. tccli/services/csip/v20221121/examples.json +13 -13
  43. tccli/services/cvm/v20170312/api.json +5 -3
  44. tccli/services/cwp/cwp_client.py +0 -53
  45. tccli/services/cwp/v20180228/api.json +0 -194
  46. tccli/services/cwp/v20180228/examples.json +0 -8
  47. tccli/services/cynosdb/v20190107/api.json +1 -1
  48. tccli/services/ess/v20201111/api.json +9 -0
  49. tccli/services/essbasic/v20210526/api.json +19 -1
  50. tccli/services/hunyuan/v20230901/api.json +2 -2
  51. tccli/services/monitor/v20180724/api.json +39 -39
  52. tccli/services/nlp/v20190408/api.json +13 -0
  53. tccli/services/ocr/v20181119/api.json +1 -1
  54. tccli/services/postgres/v20170312/examples.json +1 -1
  55. tccli/services/rum/v20210622/api.json +34 -19
  56. tccli/services/rum/v20210622/examples.json +16 -16
  57. tccli/services/ssl/v20191205/api.json +2 -2
  58. tccli/services/tdmq/v20200217/api.json +111 -1
  59. tccli/services/teo/teo_client.py +53 -0
  60. tccli/services/teo/v20220901/api.json +56 -3
  61. tccli/services/teo/v20220901/examples.json +9 -1
  62. tccli/services/trtc/v20190722/api.json +24 -6
  63. tccli/services/trtc/v20190722/examples.json +1 -1
  64. tccli/services/tsf/v20180326/api.json +80 -42
  65. tccli/services/tsf/v20180326/examples.json +1 -1
  66. tccli/services/vod/v20180717/api.json +2 -2
  67. tccli/services/vpc/v20170312/api.json +36 -23
  68. tccli/services/vpc/v20170312/examples.json +11 -11
  69. tccli/services/wedata/v20210820/api.json +465 -0
  70. tccli/services/wedata/v20210820/examples.json +1 -1
  71. {tccli-3.0.1100.1.dist-info → tccli-3.0.1102.1.dist-info}/METADATA +2 -2
  72. {tccli-3.0.1100.1.dist-info → tccli-3.0.1102.1.dist-info}/RECORD +75 -71
  73. {tccli-3.0.1100.1.dist-info → tccli-3.0.1102.1.dist-info}/WHEEL +0 -0
  74. {tccli-3.0.1100.1.dist-info → tccli-3.0.1102.1.dist-info}/entry_points.txt +0 -0
  75. {tccli-3.0.1100.1.dist-info → tccli-3.0.1102.1.dist-info}/license_files/LICENSE +0 -0
@@ -1804,9 +1804,10 @@
1804
1804
  {
1805
1805
  "disabled": false,
1806
1806
  "document": "Ckafka 的 Vip",
1807
- "example": "10.123.123.123”",
1807
+ "example": "10.10.2.42",
1808
1808
  "member": "string",
1809
1809
  "name": "Vip",
1810
+ "output_required": true,
1810
1811
  "required": true,
1811
1812
  "type": "string",
1812
1813
  "value_allowed_null": false
@@ -1814,9 +1815,10 @@
1814
1815
  {
1815
1816
  "disabled": false,
1816
1817
  "document": "Ckafka 的 Vport",
1817
- "example": "“8888”",
1818
+ "example": "9092",
1818
1819
  "member": "string",
1819
1820
  "name": "Vport",
1821
+ "output_required": true,
1820
1822
  "required": true,
1821
1823
  "type": "string",
1822
1824
  "value_allowed_null": false
@@ -1824,9 +1826,10 @@
1824
1826
  {
1825
1827
  "disabled": false,
1826
1828
  "document": "Ckafka 的 InstanceId",
1827
- "example": "“xxxxxx”",
1829
+ "example": "ckafka-8j4rotest",
1828
1830
  "member": "string",
1829
1831
  "name": "InstanceId",
1832
+ "output_required": true,
1830
1833
  "required": true,
1831
1834
  "type": "string",
1832
1835
  "value_allowed_null": false
@@ -1834,9 +1837,10 @@
1834
1837
  {
1835
1838
  "disabled": false,
1836
1839
  "document": "Ckafka 的 InstanceName",
1837
- "example": "\"myname\"",
1840
+ "example": "kafka协议消费监控用",
1838
1841
  "member": "string",
1839
1842
  "name": "InstanceName",
1843
+ "output_required": true,
1840
1844
  "required": true,
1841
1845
  "type": "string",
1842
1846
  "value_allowed_null": false
@@ -1844,9 +1848,10 @@
1844
1848
  {
1845
1849
  "disabled": false,
1846
1850
  "document": "Ckafka 的 TopicId",
1847
- "example": "\"xxxxxxxx\"",
1851
+ "example": "1254011820-24a0d67e-748b-4e30-9502-78779bcc5test",
1848
1852
  "member": "string",
1849
1853
  "name": "TopicId",
1854
+ "output_required": true,
1850
1855
  "required": true,
1851
1856
  "type": "string",
1852
1857
  "value_allowed_null": false
@@ -1854,9 +1859,10 @@
1854
1859
  {
1855
1860
  "disabled": false,
1856
1861
  "document": "Ckafka 的 TopicName",
1857
- "example": "\"xxxxxxxx\"",
1862
+ "example": "mrxy-business",
1858
1863
  "member": "string",
1859
1864
  "name": "TopicName",
1865
+ "output_required": true,
1860
1866
  "required": true,
1861
1867
  "type": "string",
1862
1868
  "value_allowed_null": false
@@ -2873,7 +2879,7 @@
2873
2879
  },
2874
2880
  {
2875
2881
  "disabled": false,
2876
- "document": "通知类型。可选值:\n<li> Trigger - 告警触发 </li>\n<li> Recovery - 告警恢复</li>\n<li> All - 告警触发和告警恢复</li>",
2882
+ "document": "通知类型。可选值:\n- Trigger - 告警触发\n- Recovery - 告警恢复\n- All - 告警触发和告警恢复\n\n\n 注意: \n- Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空\n- 2组rule配置互斥\n- rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置",
2877
2883
  "example": "All",
2878
2884
  "member": "string",
2879
2885
  "name": "Type",
@@ -2882,7 +2888,7 @@
2882
2888
  },
2883
2889
  {
2884
2890
  "disabled": false,
2885
- "document": "通知接收对象。",
2891
+ "document": "通知接收对象。\n 注意: \n- Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空\n- 2组rule配置互斥\n- rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置",
2886
2892
  "example": "无",
2887
2893
  "member": "NoticeReceiver",
2888
2894
  "name": "NoticeReceivers",
@@ -2891,7 +2897,7 @@
2891
2897
  },
2892
2898
  {
2893
2899
  "disabled": false,
2894
- "document": "接口回调信息(包括企业微信)。",
2900
+ "document": "接口回调信息(包括企业微信)。\n 注意: \n- Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空\n- 2组rule配置互斥\n- rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置",
2895
2901
  "example": "无",
2896
2902
  "member": "WebCallback",
2897
2903
  "name": "WebCallbacks",
@@ -2900,7 +2906,7 @@
2900
2906
  },
2901
2907
  {
2902
2908
  "disabled": false,
2903
- "document": "通知规则。\n\n 注意: \n\n- Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。\n\n",
2909
+ "document": "通知规则。\n 注意: \n- Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空\n- 2组rule配置互斥\n- rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置\n\n",
2904
2910
  "example": "无",
2905
2911
  "member": "NoticeRule",
2906
2912
  "name": "NoticeRules",
@@ -2916,7 +2922,7 @@
2916
2922
  {
2917
2923
  "disabled": false,
2918
2924
  "document": "告警模板ID",
2919
- "example": "xxxx-xx-xx-xx-xxxxxxxx",
2925
+ "example": "notice-f0454407-1bb2-48c7-b224-653d4b236d14",
2920
2926
  "member": "string",
2921
2927
  "name": "AlarmNoticeId",
2922
2928
  "output_required": true,
@@ -3236,7 +3242,7 @@
3236
3242
  },
3237
3243
  {
3238
3244
  "disabled": false,
3239
- "document": "类型:container_stdoutcontainer_filehost_file",
3245
+ "document": "日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。",
3240
3246
  "example": "container_stdout",
3241
3247
  "member": "string",
3242
3248
  "name": "Type",
@@ -3245,7 +3251,7 @@
3245
3251
  },
3246
3252
  {
3247
3253
  "disabled": false,
3248
- "document": "采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log",
3254
+ "document": "采集的日志类型,默认为minimalist_log。支持以下类型:\n- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));\n- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));\n- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));\n- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));\n- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));\n- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));\n- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。",
3249
3255
  "example": "minimalist_log",
3250
3256
  "member": "string",
3251
3257
  "name": "LogType",
@@ -3254,7 +3260,7 @@
3254
3260
  },
3255
3261
  {
3256
3262
  "disabled": false,
3257
- "document": "采集配置标",
3263
+ "document": "采集配置标记。\n- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置\n",
3258
3264
  "example": "label_k8s",
3259
3265
  "member": "string",
3260
3266
  "name": "ConfigFlag",
@@ -3290,7 +3296,7 @@
3290
3296
  },
3291
3297
  {
3292
3298
  "disabled": false,
3293
- "document": "节点文件配置信息",
3299
+ "document": "节点文件路径类型配置。",
3294
3300
  "example": "无",
3295
3301
  "member": "HostFileInfo",
3296
3302
  "name": "HostFile",
@@ -3299,7 +3305,7 @@
3299
3305
  },
3300
3306
  {
3301
3307
  "disabled": false,
3302
- "document": "容器文件路径信息",
3308
+ "document": "容器文件路径类型配置。",
3303
3309
  "example": "无",
3304
3310
  "member": "ContainerFileInfo",
3305
3311
  "name": "ContainerFile",
@@ -3308,7 +3314,7 @@
3308
3314
  },
3309
3315
  {
3310
3316
  "disabled": false,
3311
- "document": "容器标准输出信息",
3317
+ "document": "容器标准输出类型配置。",
3312
3318
  "example": "无",
3313
3319
  "member": "ContainerStdoutInfo",
3314
3320
  "name": "ContainerStdout",
@@ -3317,7 +3323,7 @@
3317
3323
  },
3318
3324
  {
3319
3325
  "disabled": false,
3320
- "document": "日志格式化方式",
3326
+ "document": "日志格式化方式,用于容器采集场景。\n- stdout-docker-json:用于docker容器采集场景\n- stdout-containerd:用于containerd容器采集场景",
3321
3327
  "example": "无",
3322
3328
  "member": "string",
3323
3329
  "name": "LogFormat",
@@ -3344,7 +3350,7 @@
3344
3350
  },
3345
3351
  {
3346
3352
  "disabled": false,
3347
- "document": "用户自定义采集规则,Json格式序列化的字符串",
3353
+ "document": "组合解析采集规则,用于复杂场景下的日志采集。\n- 取值参考:[使用组合解析提取模式采集日志\n](https://cloud.tencent.com/document/product/614/61310)",
3348
3354
  "example": "无",
3349
3355
  "member": "string",
3350
3356
  "name": "UserDefineRule",
@@ -3380,8 +3386,8 @@
3380
3386
  },
3381
3387
  {
3382
3388
  "disabled": false,
3383
- "document": "高级采集配置。 Json字符串, Key/Value定义为如下:\n- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时\n- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数\n- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false\n样例:{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}",
3384
- "example": "{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}",
3389
+ "document": "高级采集配置。 Json字符串, Key/Value定义为如下:\n- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时\n- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数\n- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false\n- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0\n",
3390
+ "example": "{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}",
3385
3391
  "member": "string",
3386
3392
  "name": "AdvancedConfig",
3387
3393
  "required": false,
@@ -3396,7 +3402,7 @@
3396
3402
  {
3397
3403
  "disabled": false,
3398
3404
  "document": "采集配置扩展信息ID",
3399
- "example": "xxxx-xx-xx-xx-xxxxxxxx",
3405
+ "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
3400
3406
  "member": "string",
3401
3407
  "name": "ConfigExtraId",
3402
3408
  "output_required": true,
@@ -3435,7 +3441,7 @@
3435
3441
  },
3436
3442
  {
3437
3443
  "disabled": false,
3438
- "document": "日志采集路径,包含文件名",
3444
+ "document": "日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填",
3439
3445
  "example": "/data/nginx/log/**/access.log",
3440
3446
  "member": "string",
3441
3447
  "name": "Path",
@@ -3751,7 +3757,7 @@
3751
3757
  },
3752
3758
  {
3753
3759
  "disabled": false,
3754
- "document": "加工语句。[创建加工任务](https://cloud.tencent.com/document/product/614/63940) [函数总览](https://cloud.tencent.com/document/product/614/70395)",
3760
+ "document": "加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f) \n\n其他参考文档:\n\n- [创建加工任务](https://cloud.tencent.com/document/product/614/63940) \n- [函数总览](https://cloud.tencent.com/document/product/614/70395)",
3755
3761
  "example": "fields_drop(\"message\")",
3756
3762
  "member": "string",
3757
3763
  "name": "EtlContent",
@@ -3803,7 +3809,7 @@
3803
3809
  {
3804
3810
  "disabled": false,
3805
3811
  "document": "任务id",
3806
- "example": "xxxxx",
3812
+ "example": "abdeace6-9484-4d2e-b670-28289c42b60f",
3807
3813
  "member": "string",
3808
3814
  "name": "TaskId",
3809
3815
  "output_required": true,
@@ -4240,7 +4246,7 @@
4240
4246
  },
4241
4247
  {
4242
4248
  "disabled": false,
4243
- "document": "创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。",
4249
+ "document": "创建机器组类型。取值如下:\n- Type:ip,Values中为ip字符串列表创建机器组\n- Type:label,Values中为标签字符串列表创建机器组",
4244
4250
  "example": "无",
4245
4251
  "member": "MachineGroupTypeInfo",
4246
4252
  "name": "MachineGroupType",
@@ -4312,7 +4318,7 @@
4312
4318
  },
4313
4319
  {
4314
4320
  "disabled": false,
4315
- "document": "系统类型,默认0,0:Linux1: Windows",
4321
+ "document": "系统类型,取值如下:\n- 0:Linux (默认值)\n- 1Windows",
4316
4322
  "example": "0",
4317
4323
  "member": "uint64",
4318
4324
  "name": "OSType",
@@ -5386,8 +5392,8 @@
5386
5392
  "members": [
5387
5393
  {
5388
5394
  "disabled": false,
5389
- "document": "采集规则扩展配置ID",
5390
- "example": "xxx-xxx-xxx-xxx",
5395
+ "document": "特殊采集规则扩展配置ID",
5396
+ "example": "00903f17-3e27-4f32-b1f5-489cf6e5bf08",
5391
5397
  "member": "string",
5392
5398
  "name": "ConfigExtraId",
5393
5399
  "required": true,
@@ -5521,7 +5527,7 @@
5521
5527
  {
5522
5528
  "disabled": false,
5523
5529
  "document": "数据加工任务id",
5524
- "example": "xxx",
5530
+ "example": "4c216645-01f2-414d-8a87-719b97ba205a",
5525
5531
  "member": "string",
5526
5532
  "name": "TaskId",
5527
5533
  "required": true,
@@ -6102,7 +6108,7 @@
6102
6108
  "members": [
6103
6109
  {
6104
6110
  "disabled": false,
6105
- "document": "支持的key: topicId,name, configExtraId, machineGroupId",
6111
+ "document": "过滤器,支持如下选项:\nname\n- 按照【特殊采集配置名称】进行模糊匹配过滤。\n- 类型:String\n\nconfigExtraId\n- 按照【特殊采集配置ID】进行过滤。\n- 类型:String\n\ntopicId\n- 按照【日志主题】进行过滤。\n- 类型:String\n\nmachineGroupId\n- 按照【机器组ID】进行过滤。\n- 类型:String\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
6106
6112
  "example": "无",
6107
6113
  "member": "Filter",
6108
6114
  "name": "Filters",
@@ -7955,7 +7961,7 @@
7955
7961
  },
7956
7962
  {
7957
7963
  "disabled": false,
7958
- "document": "失败日志的key\n注意:此字段可能返回 null,表示取不到有效值。",
7964
+ "document": "失败日志的key,当UnMatchUpLoadSwitch为true时必填\n注意:此字段可能返回 null,表示取不到有效值。",
7959
7965
  "example": "testlog",
7960
7966
  "member": "string",
7961
7967
  "name": "UnMatchLogKey",
@@ -7977,7 +7983,7 @@
7977
7983
  },
7978
7984
  {
7979
7985
  "disabled": false,
7980
- "document": "是否为Gbk编码。 0:否;1:是。\n注意:\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
7986
+ "document": "是否为Gbk编码。 0:否;1:是。\n注意\n- 目前取0值时,表示UTF-8编码\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
7981
7987
  "example": "0",
7982
7988
  "member": "int64",
7983
7989
  "name": "IsGBK",
@@ -7988,7 +7994,7 @@
7988
7994
  },
7989
7995
  {
7990
7996
  "disabled": false,
7991
- "document": "是否为标准json。 0:否; 1:是。\n注意:此字段可能返回 null,表示取不到有效值。",
7997
+ "document": "是否为标准json。 0:否; 1:是。\n- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。\n注意:此字段可能返回 null,表示取不到有效值。",
7992
7998
  "example": "0",
7993
7999
  "member": "int64",
7994
8000
  "name": "JsonStandard",
@@ -7999,7 +8005,7 @@
7999
8005
  },
8000
8006
  {
8001
8007
  "disabled": false,
8002
- "document": "syslog传输协议,取值为tcp或者udp。\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置。\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8008
+ "document": "syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置。\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8003
8009
  "example": "tcp",
8004
8010
  "member": "string",
8005
8011
  "name": "Protocol",
@@ -8010,7 +8016,7 @@
8010
8016
  },
8011
8017
  {
8012
8018
  "disabled": false,
8013
- "document": "syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置。\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8019
+ "document": "syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置。\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8014
8020
  "example": "127.0.0.1:9000",
8015
8021
  "member": "string",
8016
8022
  "name": "Address",
@@ -8021,7 +8027,7 @@
8021
8027
  },
8022
8028
  {
8023
8029
  "disabled": false,
8024
- "document": "rfc3164:指定系统日志采集使用RFC3164协议解析日志。\nrfc5424:指定系统日志采集使用RFC5424协议解析日志。\nauto:自动匹配rfc3164或者rfc5424其中一种协议。\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8030
+ "document": "rfc3164:指定系统日志采集使用RFC3164协议解析日志。\nrfc5424:指定系统日志采集使用RFC5424协议解析日志。\nauto:自动匹配rfc3164或者rfc5424其中一种协议。\n只有在LogType为service_syslog时生效,其余类型无需填写。\n注意:\n- 该字段适用于:创建采集规则配置、修改采集规则配置\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
8025
8031
  "example": "RFC3164",
8026
8032
  "member": "string",
8027
8033
  "name": "ParseProtocol",
@@ -8065,7 +8071,7 @@
8065
8071
  },
8066
8072
  {
8067
8073
  "disabled": false,
8068
- "document": "Windows事件日志采集。\n注意:\n- COS导入不支持此字段。",
8074
+ "document": "Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。",
8069
8075
  "example": "无",
8070
8076
  "member": "EventLog",
8071
8077
  "name": "EventLogRules",
@@ -10039,7 +10045,7 @@
10039
10045
  {
10040
10046
  "disabled": false,
10041
10047
  "document": "采集配置扩展信息id",
10042
- "example": "xxx-xxx-xxx-xxx",
10048
+ "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
10043
10049
  "member": "string",
10044
10050
  "name": "ConfigExtraId",
10045
10051
  "required": true,
@@ -10057,7 +10063,7 @@
10057
10063
  {
10058
10064
  "disabled": false,
10059
10065
  "document": "日志主题id",
10060
- "example": "xxx-xxx-xxx-xxx",
10066
+ "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
10061
10067
  "member": "string",
10062
10068
  "name": "TopicId",
10063
10069
  "required": false,
@@ -10074,7 +10080,7 @@
10074
10080
  },
10075
10081
  {
10076
10082
  "disabled": false,
10077
- "document": "容器文件路径信息",
10083
+ "document": "采集配置标记。\n- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置",
10078
10084
  "example": "无",
10079
10085
  "member": "ContainerFileInfo",
10080
10086
  "name": "ContainerFile",
@@ -10092,7 +10098,7 @@
10092
10098
  },
10093
10099
  {
10094
10100
  "disabled": false,
10095
- "document": "采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log",
10101
+ "document": "采集的日志类型,默认为minimalist_log。支持以下类型:\n- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));\n- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));\n- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));\n- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));\n- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));\n- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));\n- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。",
10096
10102
  "example": "minimalist_log",
10097
10103
  "member": "string",
10098
10104
  "name": "LogType",
@@ -10101,7 +10107,7 @@
10101
10107
  },
10102
10108
  {
10103
10109
  "disabled": false,
10104
- "document": "日志格式化方式",
10110
+ "document": "日志格式化方式,用于容器采集场景。\n- stdout-docker-json:用于docker容器采集场景\n- stdout-containerd:用于containerd容器采集场景",
10105
10111
  "example": "无",
10106
10112
  "member": "string",
10107
10113
  "name": "LogFormat",
@@ -10128,7 +10134,7 @@
10128
10134
  },
10129
10135
  {
10130
10136
  "disabled": false,
10131
- "document": "用户自定义采集规则,Json格式序列化的字符串",
10137
+ "document": "组合解析采集规则,用于复杂场景下的日志采集。\n- 取值参考:[使用组合解析提取模式采集日志\n](https://cloud.tencent.com/document/product/614/61310)",
10132
10138
  "example": "无",
10133
10139
  "member": "string",
10134
10140
  "name": "UserDefineRule",
@@ -10147,7 +10153,7 @@
10147
10153
  {
10148
10154
  "disabled": false,
10149
10155
  "document": "机器组ID",
10150
- "example": "xxxxx-925b-4cb1-b386-12740a189961",
10156
+ "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
10151
10157
  "member": "string",
10152
10158
  "name": "GroupId",
10153
10159
  "required": false,
@@ -10165,7 +10171,7 @@
10165
10171
  {
10166
10172
  "disabled": false,
10167
10173
  "document": "日志集ID",
10168
- "example": "xxxxx-925b-4cb1-b386-12740a189961",
10174
+ "example": "6ef60bec-0242-43af-bb20-270359fb54a8",
10169
10175
  "member": "string",
10170
10176
  "name": "LogsetId",
10171
10177
  "required": false,
@@ -10174,7 +10180,7 @@
10174
10180
  {
10175
10181
  "disabled": false,
10176
10182
  "document": "日志集name",
10177
- "example": "xxxxx-925b-4cb1-b386-12740a189961",
10183
+ "example": "test-logset",
10178
10184
  "member": "string",
10179
10185
  "name": "LogsetName",
10180
10186
  "required": false,
@@ -10183,7 +10189,7 @@
10183
10189
  {
10184
10190
  "disabled": false,
10185
10191
  "document": "日志主题name",
10186
- "example": "xxxxx-925b-4cb1-b386-12740a189961",
10192
+ "example": "test-topic",
10187
10193
  "member": "string",
10188
10194
  "name": "TopicName",
10189
10195
  "required": false,
@@ -10191,8 +10197,8 @@
10191
10197
  },
10192
10198
  {
10193
10199
  "disabled": false,
10194
- "document": "高级采集配置。 Json字符串, Key/Value定义为如下:\n- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时\n- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数\n- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false\n样例:{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}",
10195
- "example": "{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}",
10200
+ "document": "高级采集配置。 Json字符串, Key/Value定义为如下:\n- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时\n- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数\n- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false\n- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0\n",
10201
+ "example": "{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}",
10196
10202
  "member": "string",
10197
10203
  "name": "AdvancedConfig",
10198
10204
  "required": false,
@@ -10533,7 +10539,7 @@
10533
10539
  {
10534
10540
  "disabled": false,
10535
10541
  "document": "加工任务id",
10536
- "example": "xxxx",
10542
+ "example": "abdeace6-9484-4d2e-b670-28289c42b60f",
10537
10543
  "member": "string",
10538
10544
  "name": "TaskId",
10539
10545
  "required": true,
@@ -10550,8 +10556,8 @@
10550
10556
  },
10551
10557
  {
10552
10558
  "disabled": false,
10553
- "document": "加工语句",
10554
- "example": "xxx",
10559
+ "document": "加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f) \n\n其他参考文档:\n\n- [创建加工任务](https://cloud.tencent.com/document/product/614/63940) \n- [函数总览](https://cloud.tencent.com/document/product/614/70395)",
10560
+ "example": "fields_drop(\"message\")",
10555
10561
  "member": "string",
10556
10562
  "name": "EtlContent",
10557
10563
  "required": false,
@@ -11433,7 +11439,7 @@
11433
11439
  "members": [
11434
11440
  {
11435
11441
  "disabled": false,
11436
- "document": "接受者类型。可选值:\n<br><li> Uin - 用户ID\n<br><li> Group - 用户组ID\n暂不支持其余接收者类型。",
11442
+ "document": "接受者类型。可选值:\n- Uin - 用户ID\n- Group - 用户组ID\n暂不支持其余接收者类型。",
11437
11443
  "example": "Group",
11438
11444
  "member": "string",
11439
11445
  "name": "ReceiverType",
@@ -11444,8 +11450,8 @@
11444
11450
  },
11445
11451
  {
11446
11452
  "disabled": false,
11447
- "document": "接收者。",
11448
- "example": "[0]",
11453
+ "document": "接收者。\n当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)\n当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)",
11454
+ "example": "[1234,2345]",
11449
11455
  "member": "int64",
11450
11456
  "name": "ReceiverIds",
11451
11457
  "output_required": true,
@@ -11455,7 +11461,7 @@
11455
11461
  },
11456
11462
  {
11457
11463
  "disabled": false,
11458
- "document": "通知接收渠道。\n<br><li> Email - 邮件\n<br><li> Sms - 短信\n<br><li> WeChat - 微信\n<br><li> Phone - 电话",
11464
+ "document": "通知接收渠道。\n- Email - 邮件\n- Sms - 短信\n- WeChat - 微信\n- Phone - 电话",
11459
11465
  "example": "['Sms']",
11460
11466
  "member": "string",
11461
11467
  "name": "ReceiverChannels",
@@ -11466,7 +11472,7 @@
11466
11472
  },
11467
11473
  {
11468
11474
  "disabled": false,
11469
- "document": "允许接收信息的开始时间。",
11475
+ "document": "允许接收信息的开始时间。格式:`15:04:05`,必填。",
11470
11476
  "example": "10:04:05",
11471
11477
  "member": "string",
11472
11478
  "name": "StartTime",
@@ -11477,7 +11483,7 @@
11477
11483
  },
11478
11484
  {
11479
11485
  "disabled": false,
11480
- "document": "允许接收信息的结束时间。",
11486
+ "document": "允许接收信息的结束时间。格式:`15:04:05`,必填。",
11481
11487
  "example": "20:04:05",
11482
11488
  "member": "string",
11483
11489
  "name": "EndTime",
@@ -11488,7 +11494,7 @@
11488
11494
  },
11489
11495
  {
11490
11496
  "disabled": false,
11491
- "document": "位序",
11497
+ "document": "位序。\n\n- 入参时无效。\n- 出参时有效。",
11492
11498
  "example": "1",
11493
11499
  "member": "int64",
11494
11500
  "name": "Index",
@@ -11527,8 +11533,8 @@
11527
11533
  },
11528
11534
  {
11529
11535
  "disabled": false,
11530
- "document": "匹配规则。\n注意:此字段可能返回 null,表示取不到有效值。",
11531
- "example": "",
11536
+ "document": "匹配规则 JSON串。\n**rule格式为如下嵌套结构体JSON字符串**\n```\n{\n \"Value\": \"AND\",\n \"Type\": \"Operation\",\n \"Children\": [\n {\n \"Value\": \"OR\",\n \"Type\": \"Operation\",\n \"Children\": [\n {\n \"Type\": \"Condition\",\n \"Value\": \"Level\",\n \"Children\": [\n {\n \"Value\": \"In\",\n \"Type\": \"Compare\"\n },\n {\n \"Value\": \"[1,0]\",\n \"Type\": \"Value\"\n }\n ]\n },\n {\n \"Type\": \"Condition\",\n \"Value\": \"Level\",\n \"Children\": [\n {\n \"Value\": \"NotIn\",\n \"Type\": \"Compare\"\n },\n {\n \"Value\": \"[2]\",\n \"Type\": \"Value\"\n }\n ]\n }\n ]\n }\n ]\n}\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\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\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\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\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\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\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`\n注意:此字段可能返回 null,表示取不到有效值。",
11537
+ "example": "{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1,2]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}",
11532
11538
  "member": "string",
11533
11539
  "name": "Rule",
11534
11540
  "output_required": false,
@@ -11846,19 +11852,21 @@
11846
11852
  {
11847
11853
  "disabled": false,
11848
11854
  "document": "日志内容",
11849
- "example": "xxxx",
11855
+ "example": "{\\\"AgentStartTime\\\":\\\"6557160\\\",\\\"AvailConnNum\\\":\\\"1\\\",\\\"AvgReqSize\\\":\\\"0\\\",\\\"ConfigMinVer\\\":\\\"1715073167340919\\\",\\\"CpuMax\\\":\\\"0\\\",\\\"CpuUsage\\\":\\\"5\\\",\\\"DirMax\\\":\\\"5000\\\",\\\"FileMax\\\":\\\"15000\\\",\\\"IP\\\":\\\"9.135.76.114\\\",\\\"InstanceId\\\":\\\"loglistener-24bf21cb-0327-fc1d-be4e-5e056dadxxx\\\",\\\"Label\\\":\\\"\\\",\\\"LogConfigCnt\\\":\\\"5000\\\",\\\"MemMax\\\":\\\"2097152000\\\",\\\"MemoryUsed\\\":\\\"66678784\\\",\\\"MonitorDirs\\\":\\\"4\\\",\\\"MonitorFiles\\\":\\\"0\\\",\\\"OpenFiles\\\":\\\"0\\\",\\\"ParseFailureLogCount\\\":\\\"0\\\",\\\"QueueSize\\\":\\\"0\\\",\\\"ReadEventCnt\\\":\\\"188\\\",\\\"ResendCnt\\\":\\\"0\\\",\\\"SendAvgCost\\\":\\\"0\\\",\\\"SendFailureLogCount\\\":\\\"0\\\",\\\"SendFailureLogSize\\\":\\\"0\\\",\\\"SendFailureReqs\\\":\\\"0\\\",\\\"SendSuccessLogCount\\\":\\\"0\\\",\\\"SendSuccessLogSize\\\":\\\"0\\\",\\\"SendSuccessReqs\\\":\\\"0\\\",\\\"SendTimeoutLogCount\\\":\\\"0\\\",\\\"SendTimeoutLogSize\\\":\\\"0\\\",\\\"SendTimeoutReqs\\\":\\\"0\\\",\\\"Status\\\":\\\"22\\\",\\\"TotalFinishRsps\\\":\\\"0\\\",\\\"TotalParseLogCount\\\":\\\"0\\\",\\\"TotalSendLogCount\\\":\\\"0\\\",\\\"TotalSendLogSize\\\":\\\"0\\\",\\\"TotalSendReqs\\\":\\\"0\\\",\\\"TotalSuccessFromStart\\\":\\\"0\\\",\\\"Version\\\":\\\"2.9.0\\\",\\\"__FILENAME__\\\":\\\"status\\\",\\\"__SOURCE__\\\":\\\"9.135.76.114\\\"}",
11850
11856
  "member": "string",
11851
11857
  "name": "LogContent",
11858
+ "output_required": true,
11852
11859
  "required": true,
11853
11860
  "type": "string",
11854
11861
  "value_allowed_null": false
11855
11862
  },
11856
11863
  {
11857
11864
  "disabled": false,
11858
- "document": "行号",
11859
- "example": "1",
11865
+ "document": "行号。从0开始",
11866
+ "example": "0",
11860
11867
  "member": "int64",
11861
11868
  "name": "LineNum",
11869
+ "output_required": true,
11862
11870
  "required": true,
11863
11871
  "type": "int",
11864
11872
  "value_allowed_null": false
@@ -11866,39 +11874,43 @@
11866
11874
  {
11867
11875
  "disabled": false,
11868
11876
  "document": "目标日志主题",
11869
- "example": "topic-xx",
11877
+ "example": "4c216645-01f2-414d-8a87-719b97baxxx",
11870
11878
  "member": "string",
11871
11879
  "name": "DstTopicId",
11880
+ "output_required": true,
11872
11881
  "required": false,
11873
11882
  "type": "string",
11874
11883
  "value_allowed_null": false
11875
11884
  },
11876
11885
  {
11877
11886
  "disabled": false,
11878
- "document": "失败错误码, 空字符串\"\"表示正常",
11887
+ "document": "失败错误信息, 空字符串\"\"表示正常",
11879
11888
  "example": "error",
11880
11889
  "member": "string",
11881
11890
  "name": "FailReason",
11891
+ "output_required": true,
11882
11892
  "required": false,
11883
11893
  "type": "string",
11884
11894
  "value_allowed_null": false
11885
11895
  },
11886
11896
  {
11887
11897
  "disabled": false,
11888
- "document": "日志时间戳",
11889
- "example": "xx-xx",
11898
+ "document": "日志时间,格式:`2024-05-07 17:13:17.105`\n\n- 入参时无效\n- 出参时有效,为日志中的时间格式",
11899
+ "example": "2024-05-07 17:13:17.105",
11890
11900
  "member": "string",
11891
11901
  "name": "Time",
11902
+ "output_required": true,
11892
11903
  "required": false,
11893
11904
  "type": "string",
11894
11905
  "value_allowed_null": false
11895
11906
  },
11896
11907
  {
11897
- "disabled": false,
11908
+ "disabled": true,
11898
11909
  "document": "目标topic-name\n注意:此字段可能返回 null,表示取不到有效值。",
11899
11910
  "example": "Name",
11900
11911
  "member": "string",
11901
11912
  "name": "DstTopicName",
11913
+ "output_required": true,
11902
11914
  "required": false,
11903
11915
  "type": "string",
11904
11916
  "value_allowed_null": true
@@ -12468,6 +12480,16 @@
12468
12480
  "output_required": true,
12469
12481
  "type": "int",
12470
12482
  "value_allowed_null": true
12483
+ },
12484
+ {
12485
+ "disabled": false,
12486
+ "document": "是否开启投递服务日志。1:关闭,2:开启。\n注意:此字段可能返回 null,表示取不到有效值。",
12487
+ "example": "1",
12488
+ "member": "uint64",
12489
+ "name": "HasServicesLog",
12490
+ "output_required": false,
12491
+ "type": "int",
12492
+ "value_allowed_null": true
12471
12493
  }
12472
12494
  ],
12473
12495
  "usage": "out"
@@ -13670,8 +13692,8 @@
13670
13692
  "members": [
13671
13693
  {
13672
13694
  "disabled": false,
13673
- "document": "回调地址。",
13674
- "example": "",
13695
+ "document": "回调地址。最大支持1024个字节数。",
13696
+ "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=4c3cf1e0-a6e7-47f4-b264-5d2525c9e890",
13675
13697
  "member": "string",
13676
13698
  "name": "Url",
13677
13699
  "output_required": true,
@@ -13681,7 +13703,7 @@
13681
13703
  },
13682
13704
  {
13683
13705
  "disabled": false,
13684
- "document": "回调的类型。可选值:\n<li> WeCom\n<li> Http",
13706
+ "document": "回调的类型。可选值:\n- WeCom\n- Http\n- DingTalk\n- Lark",
13685
13707
  "example": "WeCom",
13686
13708
  "member": "string",
13687
13709
  "name": "CallbackType",
@@ -13692,7 +13714,7 @@
13692
13714
  },
13693
13715
  {
13694
13716
  "disabled": false,
13695
- "document": "回调方法。可选值:\n<li> POST\n<li> PUT\n默认值为POST。CallbackType为Http时为必选。\n注意:此字段可能返回 null,表示取不到有效值。",
13717
+ "document": "回调方法。可选值:\n- POST(默认值)\n- PUT\n\n注意:\n- 参数CallbackType为Http时为必选。\n注意:此字段可能返回 null,表示取不到有效值。",
13696
13718
  "example": "POST",
13697
13719
  "member": "string",
13698
13720
  "name": "Method",
@@ -13725,7 +13747,7 @@
13725
13747
  },
13726
13748
  {
13727
13749
  "disabled": false,
13728
- "document": "序号",
13750
+ "document": "序号。\n- 入参无效。\n- 出参有效。",
13729
13751
  "example": "1",
13730
13752
  "member": "int64",
13731
13753
  "name": "Index",