tccli 3.0.1371.1__py2.py3-none-any.whl → 3.0.1373.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/batch/v20170312/api.json +59 -59
- tccli/services/batch/v20170312/examples.json +3 -3
- tccli/services/cfg/v20210820/api.json +5 -5
- tccli/services/cfg/v20210820/examples.json +1 -1
- tccli/services/cfs/v20190719/api.json +10 -10
- tccli/services/cfs/v20190719/examples.json +1 -1
- tccli/services/ckafka/v20190819/api.json +21 -21
- tccli/services/clb/v20180317/api.json +259 -10
- tccli/services/cls/v20201016/api.json +388 -282
- tccli/services/cls/v20201016/examples.json +33 -33
- tccli/services/csip/v20221121/examples.json +1 -1
- tccli/services/ctem/v20231128/api.json +104 -104
- tccli/services/ctem/v20231128/examples.json +8 -8
- tccli/services/dnspod/v20210323/api.json +14 -4
- tccli/services/dnspod/v20210323/examples.json +2 -2
- tccli/services/es/v20180416/api.json +23 -4
- tccli/services/ess/v20201111/api.json +3 -3
- tccli/services/essbasic/v20210526/api.json +4 -4
- tccli/services/iai/v20200303/api.json +9 -0
- tccli/services/keewidb/v20220308/api.json +24 -24
- tccli/services/lcic/v20220817/api.json +46 -18
- tccli/services/lighthouse/lighthouse_client.py +106 -0
- tccli/services/lighthouse/v20200324/api.json +280 -0
- tccli/services/lighthouse/v20200324/examples.json +22 -0
- tccli/services/live/v20180801/api.json +1 -1
- tccli/services/lke/lke_client.py +0 -53
- tccli/services/lke/v20231130/api.json +29 -79
- tccli/services/lke/v20231130/examples.json +0 -8
- tccli/services/mongodb/v20190725/api.json +4 -4
- tccli/services/monitor/v20180724/api.json +7 -7
- tccli/services/mps/v20190612/api.json +42 -2
- tccli/services/ocr/v20181119/api.json +43 -14
- tccli/services/organization/v20210331/api.json +25 -25
- tccli/services/organization/v20210331/examples.json +1 -1
- tccli/services/postgres/postgres_client.py +12 -171
- tccli/services/postgres/v20170312/api.json +20 -819
- tccli/services/postgres/v20170312/examples.json +6 -30
- tccli/services/scf/v20180416/api.json +2 -0
- tccli/services/ssl/v20191205/api.json +1 -1
- tccli/services/sts/v20180813/api.json +4 -4
- tccli/services/tcbr/v20220217/api.json +92 -0
- tccli/services/tcss/v20201101/api.json +32 -2
- tccli/services/tcss/v20201101/examples.json +3 -3
- tccli/services/teo/v20220901/api.json +12 -12
- tccli/services/tione/v20211111/api.json +18 -18
- tccli/services/tke/v20180525/api.json +10 -1
- tccli/services/tms/v20201229/api.json +6 -6
- tccli/services/trabbit/v20230418/api.json +41 -2
- tccli/services/trocket/trocket_client.py +65 -12
- tccli/services/trocket/v20230308/api.json +156 -0
- tccli/services/trocket/v20230308/examples.json +8 -0
- tccli/services/trtc/trtc_client.py +159 -0
- tccli/services/trtc/v20190722/api.json +273 -9
- tccli/services/trtc/v20190722/examples.json +24 -0
- tccli/services/tse/v20201207/api.json +23 -5
- tccli/services/tse/v20201207/examples.json +2 -2
- tccli/services/tsf/v20180326/api.json +907 -802
- tccli/services/tsf/v20180326/examples.json +29 -29
- tccli/services/vod/v20180717/api.json +73 -33
- tccli/services/vod/v20180717/examples.json +1 -1
- tccli/services/vpc/v20170312/api.json +12 -2
- tccli/services/vpc/v20170312/examples.json +2 -2
- tccli/services/waf/v20180125/api.json +717 -38
- tccli/services/waf/v20180125/examples.json +56 -0
- tccli/services/waf/waf_client.py +444 -73
- tccli/services/wedata/v20210820/api.json +138 -6
- tccli/services/wsa/v20250508/api.json +21 -3
- {tccli-3.0.1371.1.dist-info → tccli-3.0.1373.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1371.1.dist-info → tccli-3.0.1373.1.dist-info}/RECORD +73 -73
- {tccli-3.0.1371.1.dist-info → tccli-3.0.1373.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1371.1.dist-info → tccli-3.0.1373.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1371.1.dist-info → tccli-3.0.1373.1.dist-info}/license_files/LICENSE +0 -0
@@ -120,7 +120,7 @@
|
|
120
120
|
"status": "online"
|
121
121
|
},
|
122
122
|
"CreateExport": {
|
123
|
-
"document": "
|
123
|
+
"document": "本接口仅创建下载任务。任务返回的下载地址,请用户调用[DescribeExports](https://cloud.tencent.com/document/product/614/56449)查看任务列表,其中有下载地址CosPath参数。",
|
124
124
|
"input": "CreateExportRequest",
|
125
125
|
"name": "创建日志下载任务",
|
126
126
|
"output": "CreateExportResponse",
|
@@ -204,7 +204,7 @@
|
|
204
204
|
"status": "online"
|
205
205
|
},
|
206
206
|
"DeleteAlarmShield": {
|
207
|
-
"document": "
|
207
|
+
"document": "该接口用于删除告警屏蔽规则。当告警屏蔽规则在生效中或者是在失效中,无法被删除",
|
208
208
|
"input": "DeleteAlarmShieldRequest",
|
209
209
|
"name": "删除告警屏蔽规则",
|
210
210
|
"output": "DeleteAlarmShieldResponse",
|
@@ -246,9 +246,9 @@
|
|
246
246
|
"status": "online"
|
247
247
|
},
|
248
248
|
"DeleteConsumer": {
|
249
|
-
"document": "
|
249
|
+
"document": "删除投递Ckafka任务",
|
250
250
|
"input": "DeleteConsumerRequest",
|
251
|
-
"name": "
|
251
|
+
"name": "删除投递Ckafka任务",
|
252
252
|
"output": "DeleteConsumerResponse",
|
253
253
|
"status": "online"
|
254
254
|
},
|
@@ -596,7 +596,7 @@
|
|
596
596
|
"status": "online"
|
597
597
|
},
|
598
598
|
"ModifyAlarmShield": {
|
599
|
-
"document": "
|
599
|
+
"document": "该接口用于修改告警屏蔽规则。当告警屏蔽规则为失效中时,无法对其进行修改",
|
600
600
|
"input": "ModifyAlarmShieldRequest",
|
601
601
|
"name": "修改告警屏蔽规则",
|
602
602
|
"output": "ModifyAlarmShieldResponse",
|
@@ -811,7 +811,7 @@
|
|
811
811
|
"members": [
|
812
812
|
{
|
813
813
|
"disabled": false,
|
814
|
-
"document": "机器组
|
814
|
+
"document": "机器组Id\n- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。",
|
815
815
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
816
816
|
"member": "string",
|
817
817
|
"name": "GroupId",
|
@@ -970,7 +970,7 @@
|
|
970
970
|
},
|
971
971
|
{
|
972
972
|
"disabled": false,
|
973
|
-
"document": "
|
973
|
+
"document": "是否触发告警的单触发条件。与MultiConditions参数互斥。",
|
974
974
|
"example": "$1.cnt > 1",
|
975
975
|
"member": "string",
|
976
976
|
"name": "Condition",
|
@@ -1030,7 +1030,7 @@
|
|
1030
1030
|
},
|
1031
1031
|
{
|
1032
1032
|
"disabled": false,
|
1033
|
-
"document": "
|
1033
|
+
"document": "创建时间。格式: YYYY-MM-DD HH:MM:SS",
|
1034
1034
|
"example": "2024-10-21 22:37:16",
|
1035
1035
|
"member": "string",
|
1036
1036
|
"name": "CreateTime",
|
@@ -1040,7 +1040,7 @@
|
|
1040
1040
|
},
|
1041
1041
|
{
|
1042
1042
|
"disabled": false,
|
1043
|
-
"document": "
|
1043
|
+
"document": "最近更新时间。格式: YYYY-MM-DD HH:MM:SS",
|
1044
1044
|
"example": "2024-10-21 22-56-18",
|
1045
1045
|
"member": "string",
|
1046
1046
|
"name": "UpdateTime",
|
@@ -1131,7 +1131,7 @@
|
|
1131
1131
|
{
|
1132
1132
|
"disabled": false,
|
1133
1133
|
"document": "告警附加分类字段。",
|
1134
|
-
"example": "
|
1134
|
+
"example": "无",
|
1135
1135
|
"member": "AlarmClassification",
|
1136
1136
|
"name": "Classifications",
|
1137
1137
|
"output_required": true,
|
@@ -1207,7 +1207,7 @@
|
|
1207
1207
|
{
|
1208
1208
|
"disabled": false,
|
1209
1209
|
"document": "告警通知模板ID。",
|
1210
|
-
"example": "notice-
|
1210
|
+
"example": "notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f",
|
1211
1211
|
"member": "string",
|
1212
1212
|
"name": "AlarmNoticeId",
|
1213
1213
|
"output_required": true,
|
@@ -1256,7 +1256,7 @@
|
|
1256
1256
|
},
|
1257
1257
|
{
|
1258
1258
|
"disabled": false,
|
1259
|
-
"document": "
|
1259
|
+
"document": "创建时间。格式: YYYY-MM-DD HH:MM:SS",
|
1260
1260
|
"example": "2022-11-07 16:30:53",
|
1261
1261
|
"member": "string",
|
1262
1262
|
"name": "CreateTime",
|
@@ -1266,7 +1266,7 @@
|
|
1266
1266
|
},
|
1267
1267
|
{
|
1268
1268
|
"disabled": false,
|
1269
|
-
"document": "
|
1269
|
+
"document": "最近更新时间。格式: YYYY-MM-DD HH:MM:SS",
|
1270
1270
|
"example": "2022-11-07 16:30:53",
|
1271
1271
|
"member": "string",
|
1272
1272
|
"name": "UpdateTime",
|
@@ -1408,7 +1408,7 @@
|
|
1408
1408
|
},
|
1409
1409
|
{
|
1410
1410
|
"disabled": false,
|
1411
|
-
"document": "
|
1411
|
+
"document": "规则创建时间。秒级时间戳(s)",
|
1412
1412
|
"example": "1701933943",
|
1413
1413
|
"member": "uint64",
|
1414
1414
|
"name": "CreateTime",
|
@@ -1418,7 +1418,7 @@
|
|
1418
1418
|
},
|
1419
1419
|
{
|
1420
1420
|
"disabled": false,
|
1421
|
-
"document": "
|
1421
|
+
"document": "规则更新时间。秒级时间戳(s)",
|
1422
1422
|
"example": "1701933943",
|
1423
1423
|
"member": "uint64",
|
1424
1424
|
"name": "UpdateTime",
|
@@ -1434,7 +1434,7 @@
|
|
1434
1434
|
"members": [
|
1435
1435
|
{
|
1436
1436
|
"disabled": false,
|
1437
|
-
"document": "日志主题ID
|
1437
|
+
"document": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID",
|
1438
1438
|
"example": "380fe1f1-0c7b-4b0d-xxxx-d514959db1bb",
|
1439
1439
|
"member": "string",
|
1440
1440
|
"name": "TopicId",
|
@@ -1468,7 +1468,7 @@
|
|
1468
1468
|
{
|
1469
1469
|
"disabled": false,
|
1470
1470
|
"document": "查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。",
|
1471
|
-
"example": "
|
1471
|
+
"example": "0",
|
1472
1472
|
"member": "int64",
|
1473
1473
|
"name": "StartTimeOffset",
|
1474
1474
|
"output_required": false,
|
@@ -1489,8 +1489,8 @@
|
|
1489
1489
|
},
|
1490
1490
|
{
|
1491
1491
|
"disabled": false,
|
1492
|
-
"document": "日志集ID
|
1493
|
-
"example": "
|
1492
|
+
"document": "日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID",
|
1493
|
+
"example": "1c072db7-2cfd-4418-xxxx-7342c7a42516",
|
1494
1494
|
"member": "string",
|
1495
1495
|
"name": "LogsetId",
|
1496
1496
|
"output_required": false,
|
@@ -1739,7 +1739,7 @@
|
|
1739
1739
|
},
|
1740
1740
|
{
|
1741
1741
|
"disabled": false,
|
1742
|
-
"document": "告警通知发送频率,单位为分钟",
|
1742
|
+
"document": "告警通知发送频率,单位为分钟(min)",
|
1743
1743
|
"example": "15",
|
1744
1744
|
"member": "int64",
|
1745
1745
|
"name": "AlarmPeriod",
|
@@ -1761,7 +1761,7 @@
|
|
1761
1761
|
},
|
1762
1762
|
{
|
1763
1763
|
"disabled": false,
|
1764
|
-
"document": "告警持续时间,单位为分钟",
|
1764
|
+
"document": "告警持续时间,单位为分钟(min)",
|
1765
1765
|
"example": "60",
|
1766
1766
|
"member": "int64",
|
1767
1767
|
"name": "Duration",
|
@@ -1783,7 +1783,7 @@
|
|
1783
1783
|
},
|
1784
1784
|
{
|
1785
1785
|
"disabled": false,
|
1786
|
-
"document": "告警发生时间,毫秒级Unix时间戳",
|
1786
|
+
"document": "告警发生时间,毫秒级Unix时间戳(ms)",
|
1787
1787
|
"example": "1619359718000",
|
1788
1788
|
"member": "uint64",
|
1789
1789
|
"name": "CreateTime",
|
@@ -1795,7 +1795,7 @@
|
|
1795
1795
|
{
|
1796
1796
|
"disabled": false,
|
1797
1797
|
"document": "告警分组触发时对应的分组信息",
|
1798
|
-
"example": "
|
1798
|
+
"example": "无",
|
1799
1799
|
"member": "GroupTriggerConditionInfo",
|
1800
1800
|
"name": "GroupTriggerCondition",
|
1801
1801
|
"output_required": true,
|
@@ -1844,7 +1844,7 @@
|
|
1844
1844
|
},
|
1845
1845
|
{
|
1846
1846
|
"disabled": false,
|
1847
|
-
"document": "分析类型:query,field ,original",
|
1847
|
+
"document": "分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志)\n",
|
1848
1848
|
"example": "query",
|
1849
1849
|
"member": "string",
|
1850
1850
|
"name": "Type",
|
@@ -1911,8 +1911,8 @@
|
|
1911
1911
|
"members": [
|
1912
1912
|
{
|
1913
1913
|
"disabled": false,
|
1914
|
-
"document": "采集配置ID",
|
1915
|
-
"example": "
|
1914
|
+
"document": "采集配置ID\n - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。",
|
1915
|
+
"example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
|
1916
1916
|
"member": "string",
|
1917
1917
|
"name": "ConfigId",
|
1918
1918
|
"required": true,
|
@@ -1920,8 +1920,8 @@
|
|
1920
1920
|
},
|
1921
1921
|
{
|
1922
1922
|
"disabled": false,
|
1923
|
-
"document": "机器组ID",
|
1924
|
-
"example": "
|
1923
|
+
"document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
|
1924
|
+
"example": "3581a3be-aa41-423b-995a-54ec84da6264",
|
1925
1925
|
"member": "string",
|
1926
1926
|
"name": "GroupId",
|
1927
1927
|
"required": true,
|
@@ -1975,7 +1975,7 @@
|
|
1975
1975
|
"members": [
|
1976
1976
|
{
|
1977
1977
|
"disabled": false,
|
1978
|
-
"document": "
|
1978
|
+
"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)",
|
1979
1979
|
"example": "fields_set(\"my_field\",\"value\")",
|
1980
1980
|
"member": "string",
|
1981
1981
|
"name": "EtlContent",
|
@@ -1984,7 +1984,7 @@
|
|
1984
1984
|
},
|
1985
1985
|
{
|
1986
1986
|
"disabled": false,
|
1987
|
-
"document": "
|
1987
|
+
"document": "加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。\n目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
1988
1988
|
"example": "无",
|
1989
1989
|
"member": "DataTransformResouceInfo",
|
1990
1990
|
"name": "DstResources",
|
@@ -2113,7 +2113,7 @@
|
|
2113
2113
|
"members": [
|
2114
2114
|
{
|
2115
2115
|
"disabled": false,
|
2116
|
-
"document": "Ckafka 的 InstanceId",
|
2116
|
+
"document": "Ckafka 的 InstanceId。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。\n- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。",
|
2117
2117
|
"example": "ckafka-8j4rotest",
|
2118
2118
|
"member": "string",
|
2119
2119
|
"name": "InstanceId",
|
@@ -2124,7 +2124,7 @@
|
|
2124
2124
|
},
|
2125
2125
|
{
|
2126
2126
|
"disabled": false,
|
2127
|
-
"document": "Ckafka 的 TopicName",
|
2127
|
+
"document": "Ckafka 的 TopicName。\n- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。\n- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。",
|
2128
2128
|
"example": "mrxy-business",
|
2129
2129
|
"member": "string",
|
2130
2130
|
"name": "TopicName",
|
@@ -2135,8 +2135,8 @@
|
|
2135
2135
|
},
|
2136
2136
|
{
|
2137
2137
|
"disabled": false,
|
2138
|
-
"document": "Ckafka 的 Vip",
|
2139
|
-
"example": "
|
2138
|
+
"document": "Ckafka 的 Vip。\n- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。\n- 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。",
|
2139
|
+
"example": "172.16.0.17",
|
2140
2140
|
"member": "string",
|
2141
2141
|
"name": "Vip",
|
2142
2142
|
"output_required": true,
|
@@ -2146,7 +2146,7 @@
|
|
2146
2146
|
},
|
2147
2147
|
{
|
2148
2148
|
"disabled": false,
|
2149
|
-
"document": "Ckafka 的 Vport",
|
2149
|
+
"document": "Ckafka 的 Vport。\n- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。\n- 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。",
|
2150
2150
|
"example": "9092",
|
2151
2151
|
"member": "string",
|
2152
2152
|
"name": "Vport",
|
@@ -2157,7 +2157,7 @@
|
|
2157
2157
|
},
|
2158
2158
|
{
|
2159
2159
|
"disabled": false,
|
2160
|
-
"document": "Ckafka 的 InstanceName",
|
2160
|
+
"document": "Ckafka 的 InstanceName。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。\n- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。\n- 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。",
|
2161
2161
|
"example": "kafka协议消费监控用",
|
2162
2162
|
"member": "string",
|
2163
2163
|
"name": "InstanceName",
|
@@ -2168,7 +2168,7 @@
|
|
2168
2168
|
},
|
2169
2169
|
{
|
2170
2170
|
"disabled": false,
|
2171
|
-
"document": "Ckafka 的 TopicId",
|
2171
|
+
"document": "Ckafka 的 TopicId。\n- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。\n- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。\n- 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。",
|
2172
2172
|
"example": "1254011820-24a0d67e-748b-4e30-9502-78779bcc5test",
|
2173
2173
|
"member": "string",
|
2174
2174
|
"name": "TopicId",
|
@@ -2185,7 +2185,7 @@
|
|
2185
2185
|
"members": [
|
2186
2186
|
{
|
2187
2187
|
"disabled": false,
|
2188
|
-
"document": "日志主题
|
2188
|
+
"document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
2189
2189
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
2190
2190
|
"member": "string",
|
2191
2191
|
"name": "FromTopicId",
|
@@ -2415,7 +2415,7 @@
|
|
2415
2415
|
{
|
2416
2416
|
"disabled": false,
|
2417
2417
|
"document": "采集规则扩展配置ID",
|
2418
|
-
"example": "
|
2418
|
+
"example": "3581a3be-aa41-423b-995a-54ec84da6264",
|
2419
2419
|
"member": "string",
|
2420
2420
|
"name": "ConfigExtraId",
|
2421
2421
|
"output_required": true,
|
@@ -2425,7 +2425,7 @@
|
|
2425
2425
|
{
|
2426
2426
|
"disabled": false,
|
2427
2427
|
"document": "采集规则名称",
|
2428
|
-
"example": "tb-
|
2428
|
+
"example": "tb-config",
|
2429
2429
|
"member": "string",
|
2430
2430
|
"name": "Name",
|
2431
2431
|
"output_required": true,
|
@@ -2435,7 +2435,7 @@
|
|
2435
2435
|
{
|
2436
2436
|
"disabled": false,
|
2437
2437
|
"document": "日志主题ID",
|
2438
|
-
"example": "
|
2438
|
+
"example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
|
2439
2439
|
"member": "string",
|
2440
2440
|
"name": "TopicId",
|
2441
2441
|
"output_required": true,
|
@@ -2444,7 +2444,7 @@
|
|
2444
2444
|
},
|
2445
2445
|
{
|
2446
2446
|
"disabled": false,
|
2447
|
-
"document": "
|
2447
|
+
"document": "自建k8s集群日志采集类型,支持\n- container_stdout 标准输出\n- container_file 标准文件\n- host_file 节点文件",
|
2448
2448
|
"example": "container_stdout",
|
2449
2449
|
"member": "string",
|
2450
2450
|
"name": "Type",
|
@@ -2485,7 +2485,7 @@
|
|
2485
2485
|
{
|
2486
2486
|
"disabled": false,
|
2487
2487
|
"document": "日志格式化方式",
|
2488
|
-
"example": "
|
2488
|
+
"example": "stdout-containerd",
|
2489
2489
|
"member": "string",
|
2490
2490
|
"name": "LogFormat",
|
2491
2491
|
"output_required": true,
|
@@ -2524,7 +2524,7 @@
|
|
2524
2524
|
},
|
2525
2525
|
{
|
2526
2526
|
"disabled": false,
|
2527
|
-
"document": "
|
2527
|
+
"document": "更新时间\n- 时间格式:yyyy-MM-dd HH:mm:ss",
|
2528
2528
|
"example": "2020-02-16 17:01:50",
|
2529
2529
|
"member": "string",
|
2530
2530
|
"name": "UpdateTime",
|
@@ -2534,7 +2534,7 @@
|
|
2534
2534
|
},
|
2535
2535
|
{
|
2536
2536
|
"disabled": false,
|
2537
|
-
"document": "
|
2537
|
+
"document": "创建时间\n- 时间格式:yyyy-MM-dd HH:mm:ss",
|
2538
2538
|
"example": "2020-02-16 17:01:50",
|
2539
2539
|
"member": "string",
|
2540
2540
|
"name": "CreateTime",
|
@@ -2554,8 +2554,8 @@
|
|
2554
2554
|
},
|
2555
2555
|
{
|
2556
2556
|
"disabled": false,
|
2557
|
-
"document": "机器组ID",
|
2558
|
-
"example": "
|
2557
|
+
"document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
|
2558
|
+
"example": "3581a3be-aa41-423b-995a-54ec84da6264",
|
2559
2559
|
"member": "string",
|
2560
2560
|
"name": "GroupId",
|
2561
2561
|
"output_required": true,
|
@@ -2574,7 +2574,7 @@
|
|
2574
2574
|
},
|
2575
2575
|
{
|
2576
2576
|
"disabled": false,
|
2577
|
-
"document": "日志集ID",
|
2577
|
+
"document": "日志集ID\n- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。",
|
2578
2578
|
"example": "b388dc72-xxxx-xxxx-9dbb-7d05fdff0376",
|
2579
2579
|
"member": "string",
|
2580
2580
|
"name": "LogsetId",
|
@@ -2651,7 +2651,7 @@
|
|
2651
2651
|
{
|
2652
2652
|
"disabled": false,
|
2653
2653
|
"document": "日志格式化方式",
|
2654
|
-
"example": "
|
2654
|
+
"example": "stdout-containerd",
|
2655
2655
|
"member": "string",
|
2656
2656
|
"name": "LogFormat",
|
2657
2657
|
"output_required": true,
|
@@ -2710,7 +2710,7 @@
|
|
2710
2710
|
},
|
2711
2711
|
{
|
2712
2712
|
"disabled": false,
|
2713
|
-
"document": "
|
2713
|
+
"document": "更新时间\n- 时间格式:yyyy-MM-dd HH:mm:ss",
|
2714
2714
|
"example": "2020-02-16 17:01:50",
|
2715
2715
|
"member": "datetime",
|
2716
2716
|
"name": "UpdateTime",
|
@@ -2720,7 +2720,7 @@
|
|
2720
2720
|
},
|
2721
2721
|
{
|
2722
2722
|
"disabled": false,
|
2723
|
-
"document": "
|
2723
|
+
"document": "创建时间\n- 时间格式:yyyy-MM-dd HH:mm:ss",
|
2724
2724
|
"example": "2020-02-16 17:01:50",
|
2725
2725
|
"member": "datetime",
|
2726
2726
|
"name": "CreateTime",
|
@@ -2900,6 +2900,100 @@
|
|
2900
2900
|
],
|
2901
2901
|
"usage": "both"
|
2902
2902
|
},
|
2903
|
+
"ConsoleSharingInfo": {
|
2904
|
+
"document": "控制台分享信息",
|
2905
|
+
"members": [
|
2906
|
+
{
|
2907
|
+
"disabled": false,
|
2908
|
+
"document": "分享ID",
|
2909
|
+
"example": "13cez28h",
|
2910
|
+
"member": "string",
|
2911
|
+
"name": "SharingId",
|
2912
|
+
"output_required": true,
|
2913
|
+
"required": true,
|
2914
|
+
"type": "string",
|
2915
|
+
"value_allowed_null": false
|
2916
|
+
},
|
2917
|
+
{
|
2918
|
+
"disabled": false,
|
2919
|
+
"document": "分享链接\n注意:此字段可能返回 null,表示取不到有效值。",
|
2920
|
+
"example": "https://clsshare.tencent-cloud.com/s/13cez28h",
|
2921
|
+
"member": "string",
|
2922
|
+
"name": "SharingUrl",
|
2923
|
+
"output_required": false,
|
2924
|
+
"required": false,
|
2925
|
+
"type": "string",
|
2926
|
+
"value_allowed_null": true
|
2927
|
+
},
|
2928
|
+
{
|
2929
|
+
"disabled": false,
|
2930
|
+
"document": "匿名分享配置信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
2931
|
+
"example": "无",
|
2932
|
+
"member": "ConsoleSharingConfig",
|
2933
|
+
"name": "SharingConfig",
|
2934
|
+
"output_required": false,
|
2935
|
+
"required": false,
|
2936
|
+
"type": "object",
|
2937
|
+
"value_allowed_null": true
|
2938
|
+
},
|
2939
|
+
{
|
2940
|
+
"disabled": false,
|
2941
|
+
"document": "过期时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
2942
|
+
"example": "1706780117413",
|
2943
|
+
"member": "uint64",
|
2944
|
+
"name": "ExpiredTime",
|
2945
|
+
"output_required": false,
|
2946
|
+
"required": false,
|
2947
|
+
"type": "int",
|
2948
|
+
"value_allowed_null": true
|
2949
|
+
},
|
2950
|
+
{
|
2951
|
+
"disabled": false,
|
2952
|
+
"document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
2953
|
+
"example": "1706780117413",
|
2954
|
+
"member": "uint64",
|
2955
|
+
"name": "CreateTime",
|
2956
|
+
"output_required": false,
|
2957
|
+
"required": false,
|
2958
|
+
"type": "int",
|
2959
|
+
"value_allowed_null": true
|
2960
|
+
},
|
2961
|
+
{
|
2962
|
+
"disabled": false,
|
2963
|
+
"document": "修改时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
2964
|
+
"example": "1706780117413",
|
2965
|
+
"member": "uint64",
|
2966
|
+
"name": "UpdateTime",
|
2967
|
+
"output_required": false,
|
2968
|
+
"required": false,
|
2969
|
+
"type": "int",
|
2970
|
+
"value_allowed_null": true
|
2971
|
+
},
|
2972
|
+
{
|
2973
|
+
"disabled": false,
|
2974
|
+
"document": "分享链接状态\n1: 正常 \n-1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)\n注意:此字段可能返回 null,表示取不到有效值。",
|
2975
|
+
"example": "1",
|
2976
|
+
"member": "uint64",
|
2977
|
+
"name": "Status",
|
2978
|
+
"output_required": false,
|
2979
|
+
"required": false,
|
2980
|
+
"type": "int",
|
2981
|
+
"value_allowed_null": true
|
2982
|
+
},
|
2983
|
+
{
|
2984
|
+
"disabled": false,
|
2985
|
+
"document": "10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,\n24005-社会\n注意:此字段可能返回 null,表示取不到有效值。",
|
2986
|
+
"example": "10001",
|
2987
|
+
"member": "uint64",
|
2988
|
+
"name": "ContentSafetyCode",
|
2989
|
+
"output_required": false,
|
2990
|
+
"required": false,
|
2991
|
+
"type": "int",
|
2992
|
+
"value_allowed_null": true
|
2993
|
+
}
|
2994
|
+
],
|
2995
|
+
"usage": "both"
|
2996
|
+
},
|
2903
2997
|
"ConsoleSharingParam": {
|
2904
2998
|
"document": "控制台分享链接params参数",
|
2905
2999
|
"members": [
|
@@ -3480,7 +3574,7 @@
|
|
3480
3574
|
"members": [
|
3481
3575
|
{
|
3482
3576
|
"disabled": false,
|
3483
|
-
"document": "
|
3577
|
+
"document": "通知渠道组名称。最大支持255个字节。 不支持 '|'。",
|
3484
3578
|
"example": "研发通知渠道组",
|
3485
3579
|
"member": "string",
|
3486
3580
|
"name": "Name",
|
@@ -3598,7 +3692,7 @@
|
|
3598
3692
|
"members": [
|
3599
3693
|
{
|
3600
3694
|
"disabled": false,
|
3601
|
-
"document": "
|
3695
|
+
"document": "告警策略名称。最大支持255个字节。 不支持 '|'。",
|
3602
3696
|
"example": "p1-业务告警",
|
3603
3697
|
"member": "string",
|
3604
3698
|
"name": "Name",
|
@@ -3643,7 +3737,7 @@
|
|
3643
3737
|
},
|
3644
3738
|
{
|
3645
3739
|
"disabled": false,
|
3646
|
-
"document": "
|
3740
|
+
"document": "关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表",
|
3647
3741
|
"example": "[\"notice-b02af159-f67b-44c3-877c-a55343f874c3\"]",
|
3648
3742
|
"member": "string",
|
3649
3743
|
"name": "AlarmNoticeIds",
|
@@ -3652,7 +3746,7 @@
|
|
3652
3746
|
},
|
3653
3747
|
{
|
3654
3748
|
"disabled": false,
|
3655
|
-
"document": "
|
3749
|
+
"document": "告警发送通知的触发条件\n 注意: \n- Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。\n",
|
3656
3750
|
"example": "$1.count > 10",
|
3657
3751
|
"member": "string",
|
3658
3752
|
"name": "Condition",
|
@@ -3797,8 +3891,8 @@
|
|
3797
3891
|
"members": [
|
3798
3892
|
{
|
3799
3893
|
"disabled": false,
|
3800
|
-
"document": "通知渠道组id
|
3801
|
-
"example": "notice-bb42f112-xxxx-
|
3894
|
+
"document": "通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id",
|
3895
|
+
"example": "notice-bb42f112-xxxx-476e-b3c4-ff5472911b42",
|
3802
3896
|
"member": "string",
|
3803
3897
|
"name": "AlarmNoticeId",
|
3804
3898
|
"required": true,
|
@@ -3806,7 +3900,7 @@
|
|
3806
3900
|
},
|
3807
3901
|
{
|
3808
3902
|
"disabled": false,
|
3809
|
-
"document": "
|
3903
|
+
"document": "屏蔽规则开始时间,秒级(s)时间戳。",
|
3810
3904
|
"example": "1701872657",
|
3811
3905
|
"member": "uint64",
|
3812
3906
|
"name": "StartTime",
|
@@ -3815,7 +3909,7 @@
|
|
3815
3909
|
},
|
3816
3910
|
{
|
3817
3911
|
"disabled": false,
|
3818
|
-
"document": "
|
3912
|
+
"document": "屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间",
|
3819
3913
|
"example": "1701883657",
|
3820
3914
|
"member": "uint64",
|
3821
3915
|
"name": "EndTime",
|
@@ -3843,7 +3937,7 @@
|
|
3843
3937
|
{
|
3844
3938
|
"disabled": false,
|
3845
3939
|
"document": "屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。",
|
3846
|
-
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"
|
3940
|
+
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"}]}",
|
3847
3941
|
"member": "string",
|
3848
3942
|
"name": "Rule",
|
3849
3943
|
"required": false,
|
@@ -3879,7 +3973,7 @@
|
|
3879
3973
|
"members": [
|
3880
3974
|
{
|
3881
3975
|
"disabled": false,
|
3882
|
-
"document": "实例ID",
|
3976
|
+
"document": "实例ID\n- 通过各个接入云产品官方文档获取",
|
3883
3977
|
"example": "ins-r8hrxxx",
|
3884
3978
|
"member": "string",
|
3885
3979
|
"name": "InstanceId",
|
@@ -3906,7 +4000,7 @@
|
|
3906
4000
|
},
|
3907
4001
|
{
|
3908
4002
|
"disabled": false,
|
3909
|
-
"document": "云产品地域。 不同日志类型(LogType)
|
4003
|
+
"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",
|
3910
4004
|
"example": "ap-guangzhou",
|
3911
4005
|
"member": "string",
|
3912
4006
|
"name": "CloudProductRegion",
|
@@ -3915,7 +4009,7 @@
|
|
3915
4009
|
},
|
3916
4010
|
{
|
3917
4011
|
"disabled": false,
|
3918
|
-
"document": "CLS
|
4012
|
+
"document": "CLS目标地域\n- 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档 ",
|
3919
4013
|
"example": "ap-guangzhou",
|
3920
4014
|
"member": "string",
|
3921
4015
|
"name": "ClsRegion",
|
@@ -3942,7 +4036,7 @@
|
|
3942
4036
|
},
|
3943
4037
|
{
|
3944
4038
|
"disabled": false,
|
3945
|
-
"document": "
|
4039
|
+
"document": "日志配置扩展信息, 一般用于存储额外的日志投递配置",
|
3946
4040
|
"example": "{\"ServiceName\":[\"HDFS\",\"KNOX\",\"YARN\",\"ZOOKEEPER\"],\"Policy\":0}",
|
3947
4041
|
"member": "string",
|
3948
4042
|
"name": "Extend",
|
@@ -3951,7 +4045,7 @@
|
|
3951
4045
|
},
|
3952
4046
|
{
|
3953
4047
|
"disabled": false,
|
3954
|
-
"document": "日志集id",
|
4048
|
+
"document": "日志集id\n- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。",
|
3955
4049
|
"example": "92cdd6d4-da98-4a6e-9494-175b44338680",
|
3956
4050
|
"member": "string",
|
3957
4051
|
"name": "LogsetId",
|
@@ -3960,7 +4054,7 @@
|
|
3960
4054
|
},
|
3961
4055
|
{
|
3962
4056
|
"disabled": false,
|
3963
|
-
"document": "日志主题id",
|
4057
|
+
"document": "日志主题id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
3964
4058
|
"example": "92cdd6d4-da98-4a6e-",
|
3965
4059
|
"member": "string",
|
3966
4060
|
"name": "TopicId",
|
@@ -4236,7 +4330,7 @@
|
|
4236
4330
|
"members": [
|
4237
4331
|
{
|
4238
4332
|
"disabled": false,
|
4239
|
-
"document": "
|
4333
|
+
"document": "采集配置名称\n- 名称种不得包含特殊字符|\n- 名称最长255字符,超过截断",
|
4240
4334
|
"example": "testname",
|
4241
4335
|
"member": "string",
|
4242
4336
|
"name": "Name",
|
@@ -4245,8 +4339,8 @@
|
|
4245
4339
|
},
|
4246
4340
|
{
|
4247
4341
|
"disabled": false,
|
4248
|
-
"document": "采集配置所属日志主题ID即TopicId",
|
4249
|
-
"example": "
|
4342
|
+
"document": "采集配置所属日志主题ID即TopicId\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
4343
|
+
"example": "f948972f-a063-408c-a59f-8c3230bddaf6",
|
4250
4344
|
"member": "string",
|
4251
4345
|
"name": "Output",
|
4252
4346
|
"required": true,
|
@@ -4291,7 +4385,7 @@
|
|
4291
4385
|
{
|
4292
4386
|
"disabled": false,
|
4293
4387
|
"document": "用户自定义采集规则,Json格式序列化的字符串。当LogType为user_define_log时,必填。",
|
4294
|
-
"example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}
|
4388
|
+
"example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}]}\"",
|
4295
4389
|
"member": "string",
|
4296
4390
|
"name": "UserDefineRule",
|
4297
4391
|
"required": false,
|
@@ -4383,8 +4477,8 @@
|
|
4383
4477
|
"members": [
|
4384
4478
|
{
|
4385
4479
|
"disabled": false,
|
4386
|
-
"document": "投递任务绑定的日志主题
|
4387
|
-
"example": "
|
4480
|
+
"document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
4481
|
+
"example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
|
4388
4482
|
"member": "string",
|
4389
4483
|
"name": "TopicId",
|
4390
4484
|
"required": true,
|
@@ -4573,7 +4667,7 @@
|
|
4573
4667
|
"members": [
|
4574
4668
|
{
|
4575
4669
|
"disabled": false,
|
4576
|
-
"document": "
|
4670
|
+
"document": "仪表盘订阅名称。\n输入限制:\n- 不能为空\n- 长度不能超过128字节\n- 不能包含字符'|'",
|
4577
4671
|
"example": "仪表盘-CLS-日报",
|
4578
4672
|
"member": "string",
|
4579
4673
|
"name": "Name",
|
@@ -4582,7 +4676,7 @@
|
|
4582
4676
|
},
|
4583
4677
|
{
|
4584
4678
|
"disabled": false,
|
4585
|
-
"document": "仪表盘
|
4679
|
+
"document": "仪表盘Id。\n- 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。",
|
4586
4680
|
"example": "dashboard-0d954d68-xxxx-xxxx-95a6-f9eff0db370f",
|
4587
4681
|
"member": "string",
|
4588
4682
|
"name": "DashboardId",
|
@@ -4591,7 +4685,7 @@
|
|
4591
4685
|
},
|
4592
4686
|
{
|
4593
4687
|
"disabled": false,
|
4594
|
-
"document": "订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期}
|
4688
|
+
"document": "订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。\n- {秒数} 取值范围: 0 ~ 59 \n- {分钟} 取值范围: 0 ~ 59 \n- {小时} 取值范围: 0 ~ 23 \n- {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) \n- {月份} 取值范围: 1 ~ 12 \n- {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】",
|
4595
4689
|
"example": "\"0 40 20 * * ?\"",
|
4596
4690
|
"member": "string",
|
4597
4691
|
"name": "Cron",
|
@@ -4736,8 +4830,8 @@
|
|
4736
4830
|
"members": [
|
4737
4831
|
{
|
4738
4832
|
"disabled": false,
|
4739
|
-
"document": "投递规则属于的
|
4740
|
-
"example": "
|
4833
|
+
"document": "投递规则属于的TopicId。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
4834
|
+
"example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
|
4741
4835
|
"member": "string",
|
4742
4836
|
"name": "TopicId",
|
4743
4837
|
"required": true,
|
@@ -4745,8 +4839,8 @@
|
|
4745
4839
|
},
|
4746
4840
|
{
|
4747
4841
|
"disabled": false,
|
4748
|
-
"document": "投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483)
|
4749
|
-
"example": "
|
4842
|
+
"document": "投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483))\n通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。",
|
4843
|
+
"example": "functionName1",
|
4750
4844
|
"member": "string",
|
4751
4845
|
"name": "FunctionName",
|
4752
4846
|
"required": true,
|
@@ -4754,8 +4848,8 @@
|
|
4754
4848
|
},
|
4755
4849
|
{
|
4756
4850
|
"disabled": false,
|
4757
|
-
"document": "
|
4758
|
-
"example": "
|
4851
|
+
"document": "命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)\n- 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。",
|
4852
|
+
"example": "ns1",
|
4759
4853
|
"member": "string",
|
4760
4854
|
"name": "Namespace",
|
4761
4855
|
"required": true,
|
@@ -4763,8 +4857,8 @@
|
|
4763
4857
|
},
|
4764
4858
|
{
|
4765
4859
|
"disabled": false,
|
4766
|
-
"document": "
|
4767
|
-
"example": "$
|
4860
|
+
"document": "函数版本。\n- 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。",
|
4861
|
+
"example": "$LATEST",
|
4768
4862
|
"member": "string",
|
4769
4863
|
"name": "Qualifier",
|
4770
4864
|
"required": true,
|
@@ -4772,7 +4866,7 @@
|
|
4772
4866
|
},
|
4773
4867
|
{
|
4774
4868
|
"disabled": false,
|
4775
|
-
"document": "
|
4869
|
+
"document": "投递最长等待时间,单位:秒。 默认:60",
|
4776
4870
|
"example": "60",
|
4777
4871
|
"member": "uint64",
|
4778
4872
|
"name": "Timeout",
|
@@ -4781,8 +4875,8 @@
|
|
4781
4875
|
},
|
4782
4876
|
{
|
4783
4877
|
"disabled": false,
|
4784
|
-
"document": "
|
4785
|
-
"example": "
|
4878
|
+
"document": "投递最大消息数。默认为100。支持范围[1,10000]",
|
4879
|
+
"example": "100",
|
4786
4880
|
"member": "uint64",
|
4787
4881
|
"name": "MaxMsgNum",
|
4788
4882
|
"required": false,
|
@@ -4808,7 +4902,7 @@
|
|
4808
4902
|
"members": [
|
4809
4903
|
{
|
4810
4904
|
"disabled": false,
|
4811
|
-
"document": "日志主题
|
4905
|
+
"document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
4812
4906
|
"example": "ee20bb16-3025-4048-b81a-dd436373062e",
|
4813
4907
|
"member": "string",
|
4814
4908
|
"name": "TopicId",
|
@@ -4881,7 +4975,7 @@
|
|
4881
4975
|
{
|
4882
4976
|
"disabled": false,
|
4883
4977
|
"document": "导出字段",
|
4884
|
-
"example": "[\"__timestamp__\"
|
4978
|
+
"example": "[\"__timestamp__\"]",
|
4885
4979
|
"member": "string",
|
4886
4980
|
"name": "DerivedFields",
|
4887
4981
|
"required": false,
|
@@ -4980,7 +5074,7 @@
|
|
4980
5074
|
"members": [
|
4981
5075
|
{
|
4982
5076
|
"disabled": false,
|
4983
|
-
"document": "导入CLS目标
|
5077
|
+
"document": "导入CLS目标TopicId。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
4984
5078
|
"example": "b53fe5be-7ee3-4031-8043-5a73bad4f572",
|
4985
5079
|
"member": "string",
|
4986
5080
|
"name": "TopicId",
|
@@ -5034,7 +5128,7 @@
|
|
5034
5128
|
},
|
5035
5129
|
{
|
5036
5130
|
"disabled": false,
|
5037
|
-
"document": "腾讯云CKafka实例ID,KafkaType为0
|
5131
|
+
"document": "腾讯云CKafka实例ID,KafkaType为0时必填。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。",
|
5038
5132
|
"example": "ckafka-2vrgxbxa",
|
5039
5133
|
"member": "string",
|
5040
5134
|
"name": "KafkaInstance",
|
@@ -5070,8 +5164,8 @@
|
|
5070
5164
|
},
|
5071
5165
|
{
|
5072
5166
|
"disabled": false,
|
5073
|
-
"document": "用户Kafka
|
5074
|
-
"example": "
|
5167
|
+
"document": "用户Kafka消费组名称。\n- 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。",
|
5168
|
+
"example": "consumer-group-name",
|
5075
5169
|
"member": "string",
|
5076
5170
|
"name": "ConsumerGroupName",
|
5077
5171
|
"required": false,
|
@@ -5162,7 +5256,7 @@
|
|
5162
5256
|
"members": [
|
5163
5257
|
{
|
5164
5258
|
"disabled": false,
|
5165
|
-
"document": "
|
5259
|
+
"document": "机器组名字。\n输入限制:\n- 最大支持255个字符,不能为空字符串\n- 不能包含字符'|'",
|
5166
5260
|
"example": "testgroup",
|
5167
5261
|
"member": "string",
|
5168
5262
|
"name": "GroupName",
|
@@ -5198,7 +5292,7 @@
|
|
5198
5292
|
},
|
5199
5293
|
{
|
5200
5294
|
"disabled": false,
|
5201
|
-
"document": "升级开始时间,建议业务低峰期升级LogListener",
|
5295
|
+
"document": "升级开始时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
5202
5296
|
"example": "\"12:00:00\"",
|
5203
5297
|
"member": "string",
|
5204
5298
|
"name": "UpdateStartTime",
|
@@ -5207,7 +5301,7 @@
|
|
5207
5301
|
},
|
5208
5302
|
{
|
5209
5303
|
"disabled": false,
|
5210
|
-
"document": "升级结束时间,建议业务低峰期升级LogListener",
|
5304
|
+
"document": "升级结束时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
5211
5305
|
"example": "\"13:00:00\"",
|
5212
5306
|
"member": "string",
|
5213
5307
|
"name": "UpdateEndTime",
|
@@ -5225,7 +5319,7 @@
|
|
5225
5319
|
},
|
5226
5320
|
{
|
5227
5321
|
"disabled": false,
|
5228
|
-
"document": "
|
5322
|
+
"document": "机器组中机器离线清理时间。单位:天\n\n- 大于0时生效。",
|
5229
5323
|
"example": "30",
|
5230
5324
|
"member": "int64",
|
5231
5325
|
"name": "DelayCleanupTime",
|
@@ -5280,7 +5374,7 @@
|
|
5280
5374
|
"members": [
|
5281
5375
|
{
|
5282
5376
|
"disabled": false,
|
5283
|
-
"document": "
|
5377
|
+
"document": "模板名称。最大支持255个字节",
|
5284
5378
|
"example": "告警内容模板",
|
5285
5379
|
"member": "string",
|
5286
5380
|
"name": "Name",
|
@@ -5314,7 +5408,7 @@
|
|
5314
5408
|
{
|
5315
5409
|
"disabled": false,
|
5316
5410
|
"document": "通知内容配置ID",
|
5317
|
-
"example": "noticetemplate-
|
5411
|
+
"example": "noticetemplate-5431432e-1370-490a-b43f-2757e07264c4",
|
5318
5412
|
"member": "string",
|
5319
5413
|
"name": "NoticeContentId",
|
5320
5414
|
"output_required": true,
|
@@ -5335,7 +5429,7 @@
|
|
5335
5429
|
"members": [
|
5336
5430
|
{
|
5337
5431
|
"disabled": false,
|
5338
|
-
"document": "源日志主题",
|
5432
|
+
"document": "源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
5339
5433
|
"example": "6ef60bec-0242-43af-bb20-270359fbxxx",
|
5340
5434
|
"member": "string",
|
5341
5435
|
"name": "SrcTopicId",
|
@@ -5344,7 +5438,7 @@
|
|
5344
5438
|
},
|
5345
5439
|
{
|
5346
5440
|
"disabled": false,
|
5347
|
-
"document": "
|
5441
|
+
"document": "任务名称,0~255字符",
|
5348
5442
|
"example": "scheduler_sql_delete_task",
|
5349
5443
|
"member": "string",
|
5350
5444
|
"name": "Name",
|
@@ -5398,7 +5492,7 @@
|
|
5398
5492
|
},
|
5399
5493
|
{
|
5400
5494
|
"disabled": false,
|
5401
|
-
"document": "调度周期(分钟)",
|
5495
|
+
"document": "调度周期(分钟),1~1440分钟",
|
5402
5496
|
"example": "2",
|
5403
5497
|
"member": "int64",
|
5404
5498
|
"name": "ProcessPeriod",
|
@@ -5416,7 +5510,7 @@
|
|
5416
5510
|
},
|
5417
5511
|
{
|
5418
5512
|
"disabled": false,
|
5419
|
-
"document": "执行延迟(秒)",
|
5513
|
+
"document": "执行延迟(秒),0~120秒,默认60秒",
|
5420
5514
|
"example": "60",
|
5421
5515
|
"member": "int64",
|
5422
5516
|
"name": "ProcessDelay",
|
@@ -5425,7 +5519,7 @@
|
|
5425
5519
|
},
|
5426
5520
|
{
|
5427
5521
|
"disabled": false,
|
5428
|
-
"document": "源topicId
|
5522
|
+
"document": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档",
|
5429
5523
|
"example": "ap-guangzhou",
|
5430
5524
|
"member": "string",
|
5431
5525
|
"name": "SrcTopicRegion",
|
@@ -5634,8 +5728,8 @@
|
|
5634
5728
|
"members": [
|
5635
5729
|
{
|
5636
5730
|
"disabled": false,
|
5637
|
-
"document": "日志集ID",
|
5638
|
-
"example": "
|
5731
|
+
"document": "日志集ID\n- 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。",
|
5732
|
+
"example": "64aebb76-644b-4e60-90f6-3c183094da40-ab2f-47ab-9dcd-31413b057812",
|
5639
5733
|
"member": "string",
|
5640
5734
|
"name": "LogsetId",
|
5641
5735
|
"required": true,
|
@@ -5643,7 +5737,7 @@
|
|
5643
5737
|
},
|
5644
5738
|
{
|
5645
5739
|
"disabled": false,
|
5646
|
-
"document": "
|
5740
|
+
"document": "日志主题名称\n名称限制\n- 不能为空字符串\n- 不能包含字符'|'\n- 不能使用以下名称[\"cls_service_log\",\"loglistener_status\",\"loglistener_alarm\",\"loglistener_business\",\"cls_service_metric\"]\n",
|
5647
5741
|
"example": "testname",
|
5648
5742
|
"member": "string",
|
5649
5743
|
"name": "TopicName",
|
@@ -5725,7 +5819,7 @@
|
|
5725
5819
|
{
|
5726
5820
|
"disabled": false,
|
5727
5821
|
"document": "主题自定义ID,格式为:用户自定义部分-APPID。未填写该参数时将自动生成ID。\n- 用户自定义部分仅支持小写字母、数字和-,且不能以-开头和结尾,长度为3至40字符\n- APPID可在https://console.cloud.tencent.com/developer页面查询",
|
5728
|
-
"example": "
|
5822
|
+
"example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
|
5729
5823
|
"member": "string",
|
5730
5824
|
"name": "TopicId",
|
5731
5825
|
"required": false,
|
@@ -5779,7 +5873,7 @@
|
|
5779
5873
|
"members": [
|
5780
5874
|
{
|
5781
5875
|
"disabled": false,
|
5782
|
-
"document": "
|
5876
|
+
"document": "通知内容名称。最大支持255个字节",
|
5783
5877
|
"example": "监控告警专用",
|
5784
5878
|
"member": "string",
|
5785
5879
|
"name": "Name",
|
@@ -5815,7 +5909,7 @@
|
|
5815
5909
|
},
|
5816
5910
|
{
|
5817
5911
|
"disabled": false,
|
5818
|
-
"document": "
|
5912
|
+
"document": "秘钥。最大支持1024个字节",
|
5819
5913
|
"example": "AASFFGGYYBHGTDJ",
|
5820
5914
|
"member": "string",
|
5821
5915
|
"name": "Key",
|
@@ -5831,7 +5925,7 @@
|
|
5831
5925
|
{
|
5832
5926
|
"disabled": false,
|
5833
5927
|
"document": "回调配置ID。",
|
5834
|
-
"example": "webcallback-
|
5928
|
+
"example": "webcallback-57069150-273b-46e0-b692-aff5ff92cc8c",
|
5835
5929
|
"member": "string",
|
5836
5930
|
"name": "WebCallbackId",
|
5837
5931
|
"output_required": true,
|
@@ -6029,7 +6123,7 @@
|
|
6029
6123
|
"members": [
|
6030
6124
|
{
|
6031
6125
|
"disabled": false,
|
6032
|
-
"document": "仪表盘通知方式。<br>\n<li/>Uin:腾讯云用户<br>\n<li/>Group:腾讯云用户组<br>\n<li/>Email:自定义Email<br>\n<li/>WeCom:
|
6126
|
+
"document": "仪表盘通知方式。<br>\n<li/>Uin:腾讯云用户<br>\n<li/>Group:腾讯云用户组<br>\n<li/>Email:自定义Email<br>\n<li/>WeCom: 企业微信回调<br>\n<li/>DingTalk:钉钉<br>\n<li/>Lark:飞书",
|
6033
6127
|
"example": "Email",
|
6034
6128
|
"member": "string",
|
6035
6129
|
"name": "ReceiverType",
|
@@ -6041,7 +6135,7 @@
|
|
6041
6135
|
{
|
6042
6136
|
"disabled": false,
|
6043
6137
|
"document": "知方式对应的值。\n<br> <li/> 当ReceiverType不是 WeCom 时,Values必填。",
|
6044
|
-
"example": "[\"168053\",\"
|
6138
|
+
"example": "[\"168053\",\"1\"]",
|
6045
6139
|
"member": "string",
|
6046
6140
|
"name": "Values",
|
6047
6141
|
"output_required": true,
|
@@ -6410,8 +6504,8 @@
|
|
6410
6504
|
"members": [
|
6411
6505
|
{
|
6412
6506
|
"disabled": false,
|
6413
|
-
"document": "通知渠道组ID",
|
6414
|
-
"example": "notice-
|
6507
|
+
"document": "通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID",
|
6508
|
+
"example": "notice-d7286484-46d9-4be3-b7ba-2c464e6a5ad1",
|
6415
6509
|
"member": "string",
|
6416
6510
|
"name": "AlarmNoticeId",
|
6417
6511
|
"required": true,
|
@@ -6464,8 +6558,8 @@
|
|
6464
6558
|
"members": [
|
6465
6559
|
{
|
6466
6560
|
"disabled": false,
|
6467
|
-
"document": "屏蔽规则id
|
6468
|
-
"example": "
|
6561
|
+
"document": "屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID",
|
6562
|
+
"example": "bc42f172-a74d-496e-b3c4-ff5472911b42",
|
6469
6563
|
"member": "string",
|
6470
6564
|
"name": "TaskId",
|
6471
6565
|
"required": true,
|
@@ -6473,8 +6567,8 @@
|
|
6473
6567
|
},
|
6474
6568
|
{
|
6475
6569
|
"disabled": false,
|
6476
|
-
"document": "通知渠道组id
|
6477
|
-
"example": "notice-bb42f112-a74d-
|
6570
|
+
"document": "通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id",
|
6571
|
+
"example": "notice-bb42f112-a74d-476e-b3c4-ff5472911b42",
|
6478
6572
|
"member": "string",
|
6479
6573
|
"name": "AlarmNoticeId",
|
6480
6574
|
"required": true,
|
@@ -6527,7 +6621,7 @@
|
|
6527
6621
|
},
|
6528
6622
|
{
|
6529
6623
|
"disabled": false,
|
6530
|
-
"document": "云产品地域。 不同日志类型(LogType)
|
6624
|
+
"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",
|
6531
6625
|
"example": "ap-guangzhou",
|
6532
6626
|
"member": "string",
|
6533
6627
|
"name": "CloudProductRegion",
|
@@ -6564,7 +6658,7 @@
|
|
6564
6658
|
"members": [
|
6565
6659
|
{
|
6566
6660
|
"disabled": false,
|
6567
|
-
"document": "特殊采集规则扩展配置ID",
|
6661
|
+
"document": "特殊采集规则扩展配置ID\n- 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。",
|
6568
6662
|
"example": "00903f17-3e27-4f32-b1f5-489cf6e5bf08",
|
6569
6663
|
"member": "string",
|
6570
6664
|
"name": "ConfigExtraId",
|
@@ -6591,8 +6685,8 @@
|
|
6591
6685
|
"members": [
|
6592
6686
|
{
|
6593
6687
|
"disabled": false,
|
6594
|
-
"document": "机器组ID",
|
6595
|
-
"example": "
|
6688
|
+
"document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
|
6689
|
+
"example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
|
6596
6690
|
"member": "string",
|
6597
6691
|
"name": "GroupId",
|
6598
6692
|
"required": true,
|
@@ -6600,8 +6694,8 @@
|
|
6600
6694
|
},
|
6601
6695
|
{
|
6602
6696
|
"disabled": false,
|
6603
|
-
"document": "采集配置ID",
|
6604
|
-
"example": "
|
6697
|
+
"document": "采集配置ID\n - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。",
|
6698
|
+
"example": "3581a3be-aa41-423b-995a-54ec84da6264",
|
6605
6699
|
"member": "string",
|
6606
6700
|
"name": "ConfigId",
|
6607
6701
|
"required": true,
|
@@ -6627,8 +6721,8 @@
|
|
6627
6721
|
"members": [
|
6628
6722
|
{
|
6629
6723
|
"disabled": false,
|
6630
|
-
"document": "
|
6631
|
-
"example": "
|
6724
|
+
"document": "采集配置ID\n - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。",
|
6725
|
+
"example": "3581a3be-aa41-423b-995a-54ec84da6264",
|
6632
6726
|
"member": "string",
|
6633
6727
|
"name": "ConfigId",
|
6634
6728
|
"required": true,
|
@@ -6654,7 +6748,7 @@
|
|
6654
6748
|
"members": [
|
6655
6749
|
{
|
6656
6750
|
"disabled": false,
|
6657
|
-
"document": "免密分享Id",
|
6751
|
+
"document": "免密分享Id。\n- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 \n- 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。",
|
6658
6752
|
"example": "13cez28h",
|
6659
6753
|
"member": "string",
|
6660
6754
|
"name": "SharingId",
|
@@ -6681,8 +6775,8 @@
|
|
6681
6775
|
"members": [
|
6682
6776
|
{
|
6683
6777
|
"disabled": false,
|
6684
|
-
"document": "投递任务绑定的日志主题
|
6685
|
-
"example": "
|
6778
|
+
"document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
6779
|
+
"example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
|
6686
6780
|
"member": "string",
|
6687
6781
|
"name": "TopicId",
|
6688
6782
|
"required": true,
|
@@ -6771,7 +6865,7 @@
|
|
6771
6865
|
"members": [
|
6772
6866
|
{
|
6773
6867
|
"disabled": false,
|
6774
|
-
"document": "数据加工任务
|
6868
|
+
"document": "数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。",
|
6775
6869
|
"example": "4c216645-01f2-414d-8a87-719b97ba205a",
|
6776
6870
|
"member": "string",
|
6777
6871
|
"name": "TaskId",
|
@@ -6798,7 +6892,7 @@
|
|
6798
6892
|
"members": [
|
6799
6893
|
{
|
6800
6894
|
"disabled": false,
|
6801
|
-
"document": "
|
6895
|
+
"document": "日志导出任务Id\n- 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。\n",
|
6802
6896
|
"example": "57196a6a-7622-47be-bc92-d2ebea959a0f",
|
6803
6897
|
"member": "string",
|
6804
6898
|
"name": "ExportId",
|
@@ -6915,7 +7009,7 @@
|
|
6915
7009
|
"members": [
|
6916
7010
|
{
|
6917
7011
|
"disabled": false,
|
6918
|
-
"document": "机器组
|
7012
|
+
"document": "机器组Id\n- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。",
|
6919
7013
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
6920
7014
|
"member": "string",
|
6921
7015
|
"name": "GroupId",
|
@@ -6951,7 +7045,7 @@
|
|
6951
7045
|
"members": [
|
6952
7046
|
{
|
6953
7047
|
"disabled": false,
|
6954
|
-
"document": "机器组
|
7048
|
+
"document": "机器组Id\n- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。",
|
6955
7049
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
6956
7050
|
"member": "string",
|
6957
7051
|
"name": "GroupId",
|
@@ -6978,8 +7072,8 @@
|
|
6978
7072
|
"members": [
|
6979
7073
|
{
|
6980
7074
|
"disabled": false,
|
6981
|
-
"document": "通知内容模板ID",
|
6982
|
-
"example": "noticetemplate-
|
7075
|
+
"document": "通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID",
|
7076
|
+
"example": "noticetemplate-d72867484-46d9-4be3-b7ba-2c464e6a5ad1",
|
6983
7077
|
"member": "string",
|
6984
7078
|
"name": "NoticeContentId",
|
6985
7079
|
"required": true,
|
@@ -7005,8 +7099,8 @@
|
|
7005
7099
|
"members": [
|
7006
7100
|
{
|
7007
7101
|
"disabled": false,
|
7008
|
-
"document": "任务ID",
|
7009
|
-
"example": "
|
7102
|
+
"document": "任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
|
7103
|
+
"example": "absbdbfb-0242-43af-bb20-270359fb5xxx",
|
7010
7104
|
"member": "string",
|
7011
7105
|
"name": "TaskId",
|
7012
7106
|
"required": true,
|
@@ -7014,7 +7108,7 @@
|
|
7014
7108
|
},
|
7015
7109
|
{
|
7016
7110
|
"disabled": false,
|
7017
|
-
"document": "源日志主题ID",
|
7111
|
+
"document": "源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
|
7018
7112
|
"example": "6ef60bec-0242-43af-bb20-270359fxxxx",
|
7019
7113
|
"member": "string",
|
7020
7114
|
"name": "SrcTopicId",
|
@@ -7068,7 +7162,7 @@
|
|
7068
7162
|
"members": [
|
7069
7163
|
{
|
7070
7164
|
"disabled": false,
|
7071
|
-
"document": "日志主题ID",
|
7165
|
+
"document": "日志主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
7072
7166
|
"example": "a5ce0c9c-0690-44a5-bc79-5f2190626bd0",
|
7073
7167
|
"member": "string",
|
7074
7168
|
"name": "TopicId",
|
@@ -7095,8 +7189,8 @@
|
|
7095
7189
|
"members": [
|
7096
7190
|
{
|
7097
7191
|
"disabled": false,
|
7098
|
-
"document": "告警渠道回调配置ID
|
7099
|
-
"example": "webcallback-
|
7192
|
+
"document": "告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID",
|
7193
|
+
"example": "webcallback-d7286794-46d9-4be3-b7ba-2c464e6a5ad1",
|
7100
7194
|
"member": "string",
|
7101
7195
|
"name": "WebCallbackId",
|
7102
7196
|
"required": true,
|
@@ -7133,8 +7227,8 @@
|
|
7133
7227
|
},
|
7134
7228
|
{
|
7135
7229
|
"disabled": false,
|
7136
|
-
"document": "日志主题ID
|
7137
|
-
"example": "
|
7230
|
+
"document": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID",
|
7231
|
+
"example": "17312724-asdfa-13513-66254",
|
7138
7232
|
"member": "string",
|
7139
7233
|
"name": "TopicId",
|
7140
7234
|
"output_required": true,
|
@@ -7161,7 +7255,7 @@
|
|
7161
7255
|
"members": [
|
7162
7256
|
{
|
7163
7257
|
"disabled": false,
|
7164
|
-
"document": "<li> name\n按照【通知渠道组名称】进行过滤。\n类型:String\n必选:否</li>\n<li> alarmNoticeId\n按照【通知渠道组ID】进行过滤。\n类型:String\n必选:否</li>\n<li> uid\n按照【接收用户ID】进行过滤。\n类型:String\n必选:否</li>\n<li> groupId\n按照【接收用户组ID】进行过滤。\n类型:String\n必选:否</li>\n\n<li> deliverFlag\n按照【投递状态】进行过滤。\n类型:String\n必选:否\n可选值: \"1\":未启用, \"2\": 已启用, \"3\":投递异常</li>\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7258
|
+
"document": "<li> name\n按照【通知渠道组名称】进行过滤。\n类型:String\n示例:\"Filters\":[{\"Key\":\"name\",\"Values\":[\"test-notice\"]}]\n必选:否</li>\n<li> alarmNoticeId\n按照【通知渠道组ID】进行过滤。\n类型:String\n示例:\"Filters\": [{Key: \"alarmNoticeId\", Values: [\"notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f\"]}]\n必选:否</li>\n<li> uid\n按照【接收用户ID】进行过滤。\n类型:String\n示例:\"Filters\": [{Key: \"uid\", Values: [\"1137546\"]}]\n必选:否</li>\n<li> groupId\n按照【接收用户组ID】进行过滤。\n类型:String\n示例:\"Filters\": [{Key: \"groupId\", Values: [\"344098\"]}]\n必选:否</li>\n\n<li> deliverFlag\n按照【投递状态】进行过滤。\n类型:String\n必选:否\n可选值: \"1\":未启用, \"2\": 已启用, \"3\":投递异常</li>\n示例:\"Filters\":[{\"Key\":\"deliverFlag\",\"Values\":[\"2\"]}]\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7165
7259
|
"example": "无",
|
7166
7260
|
"member": "Filter",
|
7167
7261
|
"name": "Filters",
|
@@ -7227,7 +7321,7 @@
|
|
7227
7321
|
{
|
7228
7322
|
"disabled": false,
|
7229
7323
|
"document": "通知渠道组id。",
|
7230
|
-
"example": "notice-bb42f112-xxxx-
|
7324
|
+
"example": "notice-bb42f112-xxxx-476e-b3c4-ff5472911b42",
|
7231
7325
|
"member": "string",
|
7232
7326
|
"name": "AlarmNoticeId",
|
7233
7327
|
"required": true,
|
@@ -7300,7 +7394,7 @@
|
|
7300
7394
|
"members": [
|
7301
7395
|
{
|
7302
7396
|
"disabled": false,
|
7303
|
-
"document": "name\n- 按照【告警策略名称】进行过滤。\n- 类型:String\n- 必选:否\n\nalarmId\n- 按照【告警策略ID】进行过滤。\n- 类型:String\n- 必选:否\n\ntopicId\n- 按照【监控对象的日志主题ID】进行过滤。\n- 类型:String\n- 必选:否\n\nenable\n- 按照【启用状态】进行过滤。\n- 类型:String\n- 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.\n- 必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7397
|
+
"document": "name\n- 按照【告警策略名称】进行过滤。\n- 类型:String\n- 必选:否\n- 示例:test-alarm\n\nalarmId\n- 按照【告警策略ID】进行过滤。\n- 类型:String\n- 必选:否\n- 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751\n\ntopicId\n- 按照【监控对象的日志主题ID】进行过滤。\n- 类型:String\n- 必选:否\n- 示例:6766f83d-659e-xxxx-a8f7-9104a1012743\n\nenable\n- 按照【启用状态】进行过滤。\n- 类型:String\n- 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.\n- 必选:否\n- 示例:true\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7304
7398
|
"example": "无",
|
7305
7399
|
"member": "Filter",
|
7306
7400
|
"name": "Filters",
|
@@ -7337,6 +7431,7 @@
|
|
7337
7431
|
"example": "无",
|
7338
7432
|
"member": "AlarmInfo",
|
7339
7433
|
"name": "Alarms",
|
7434
|
+
"output_required": true,
|
7340
7435
|
"type": "list",
|
7341
7436
|
"value_allowed_null": false
|
7342
7437
|
},
|
@@ -7346,6 +7441,7 @@
|
|
7346
7441
|
"example": "0",
|
7347
7442
|
"member": "int64",
|
7348
7443
|
"name": "TotalCount",
|
7444
|
+
"output_required": true,
|
7349
7445
|
"type": "int",
|
7350
7446
|
"value_allowed_null": false
|
7351
7447
|
},
|
@@ -7363,7 +7459,7 @@
|
|
7363
7459
|
"members": [
|
7364
7460
|
{
|
7365
7461
|
"disabled": false,
|
7366
|
-
"document": "查询时间范围启始时间,毫秒级unix时间戳",
|
7462
|
+
"document": "查询时间范围启始时间,毫秒级unix时间戳(ms)",
|
7367
7463
|
"example": "1619063300000",
|
7368
7464
|
"member": "uint64",
|
7369
7465
|
"name": "From",
|
@@ -7372,7 +7468,7 @@
|
|
7372
7468
|
},
|
7373
7469
|
{
|
7374
7470
|
"disabled": false,
|
7375
|
-
"document": "查询时间范围结束时间,毫秒级unix时间戳",
|
7471
|
+
"document": "查询时间范围结束时间,毫秒级unix时间戳(ms)",
|
7376
7472
|
"example": "1619581700000",
|
7377
7473
|
"member": "uint64",
|
7378
7474
|
"name": "To",
|
@@ -7511,7 +7607,7 @@
|
|
7511
7607
|
"members": [
|
7512
7608
|
{
|
7513
7609
|
"disabled": false,
|
7514
|
-
"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。",
|
7610
|
+
"document": "过滤器,支持如下选项:\nname\n- 按照【特殊采集配置名称】进行模糊匹配过滤。\n- 类型:String\n- 示例:test-config\n\nconfigExtraId\n- 按照【特殊采集配置ID】进行过滤。\n- 类型:String\n- 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a\n\ntopicId\n- 按照【日志主题】进行过滤。\n- 类型:String\n- 示例:3581a3be-aa41-423b-995a-54ec84da6264\n\nmachineGroupId\n- 按照【机器组ID】进行过滤。\n- 类型:String\n- 示例:f948972f-a063-408c-a59f-8c3230bddaf6\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7515
7611
|
"example": "无",
|
7516
7612
|
"member": "Filter",
|
7517
7613
|
"name": "Filters",
|
@@ -7576,8 +7672,8 @@
|
|
7576
7672
|
"members": [
|
7577
7673
|
{
|
7578
7674
|
"disabled": false,
|
7579
|
-
"document": "采集配置ID",
|
7580
|
-
"example": "
|
7675
|
+
"document": "采集配置ID\n- 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。",
|
7676
|
+
"example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
|
7581
7677
|
"member": "string",
|
7582
7678
|
"name": "ConfigId",
|
7583
7679
|
"required": true,
|
@@ -7613,7 +7709,7 @@
|
|
7613
7709
|
"members": [
|
7614
7710
|
{
|
7615
7711
|
"disabled": false,
|
7616
|
-
"document": "configName\n- 按照【采集配置名称】进行模糊匹配过滤。\n- 类型:String\n- 必选:否\n\nconfigId\n- 按照【采集配置ID】进行过滤。\n- 类型:String\n- 必选:否\n\ntopicId\n- 按照【日志主题】进行过滤。\n- 类型:String\n- 必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7712
|
+
"document": "configName\n- 按照【采集配置名称】进行模糊匹配过滤。\n- 类型:String\n- 必选:否\n- 示例:test-config\n\nconfigId\n- 按照【采集配置ID】进行过滤。\n- 类型:String\n- 必选:否\n- 示例:3581a3be-aa41-423b-995a-54ec84da6264\n\ntopicId\n- 按照【日志主题】进行过滤。\n- 类型:String\n- 必选:否\n- 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
7617
7713
|
"example": "无",
|
7618
7714
|
"member": "Filter",
|
7619
7715
|
"name": "Filters",
|
@@ -7691,6 +7787,16 @@
|
|
7691
7787
|
"type": "int",
|
7692
7788
|
"value_allowed_null": false
|
7693
7789
|
},
|
7790
|
+
{
|
7791
|
+
"disabled": false,
|
7792
|
+
"document": "控制台免密分享列表",
|
7793
|
+
"example": "无",
|
7794
|
+
"member": "ConsoleSharingInfo",
|
7795
|
+
"name": "ConsoleSharingInfos",
|
7796
|
+
"output_required": true,
|
7797
|
+
"type": "list",
|
7798
|
+
"value_allowed_null": false
|
7799
|
+
},
|
7694
7800
|
{
|
7695
7801
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
7696
7802
|
"member": "string",
|
@@ -7705,8 +7811,8 @@
|
|
7705
7811
|
"members": [
|
7706
7812
|
{
|
7707
7813
|
"disabled": false,
|
7708
|
-
"document": "投递任务绑定的日志主题
|
7709
|
-
"example": "
|
7814
|
+
"document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
7815
|
+
"example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
|
7710
7816
|
"member": "string",
|
7711
7817
|
"name": "TopicId",
|
7712
7818
|
"required": true,
|
@@ -8039,7 +8145,7 @@
|
|
8039
8145
|
"members": [
|
8040
8146
|
{
|
8041
8147
|
"disabled": false,
|
8042
|
-
"document": "日志主题
|
8148
|
+
"document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
8043
8149
|
"example": "ee20bb16-3025-4048-b81a-dd436373062e",
|
8044
8150
|
"member": "string",
|
8045
8151
|
"name": "TopicId",
|
@@ -8073,10 +8179,10 @@
|
|
8073
8179
|
{
|
8074
8180
|
"disabled": false,
|
8075
8181
|
"document": "日志导出列表",
|
8076
|
-
"example": "
|
8182
|
+
"example": "无",
|
8077
8183
|
"member": "ExportInfo",
|
8078
8184
|
"name": "Exports",
|
8079
|
-
"
|
8185
|
+
"output_required": true,
|
8080
8186
|
"type": "list",
|
8081
8187
|
"value_allowed_null": false
|
8082
8188
|
},
|
@@ -8086,7 +8192,7 @@
|
|
8086
8192
|
"example": "1",
|
8087
8193
|
"member": "int64",
|
8088
8194
|
"name": "TotalCount",
|
8089
|
-
"
|
8195
|
+
"output_required": true,
|
8090
8196
|
"type": "int",
|
8091
8197
|
"value_allowed_null": false
|
8092
8198
|
},
|
@@ -8191,7 +8297,7 @@
|
|
8191
8297
|
"members": [
|
8192
8298
|
{
|
8193
8299
|
"disabled": false,
|
8194
|
-
"document": "日志主题
|
8300
|
+
"document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
8195
8301
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
8196
8302
|
"member": "string",
|
8197
8303
|
"name": "FromTopicId",
|
@@ -8258,7 +8364,7 @@
|
|
8258
8364
|
"members": [
|
8259
8365
|
{
|
8260
8366
|
"disabled": false,
|
8261
|
-
"document": "日志主题
|
8367
|
+
"document": "日志主题Id。\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
8262
8368
|
"example": "6bf3355c-xxxx-xxxx-89c8-76c3ca37bae9",
|
8263
8369
|
"member": "string",
|
8264
8370
|
"name": "TopicId",
|
@@ -8267,7 +8373,7 @@
|
|
8267
8373
|
},
|
8268
8374
|
{
|
8269
8375
|
"disabled": false,
|
8270
|
-
"document": "导入配置
|
8376
|
+
"document": "导入配置Id。\n- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。\n- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。",
|
8271
8377
|
"example": "f574db7d-45ff-xxxx-xxxx-35f7fe71a4d0",
|
8272
8378
|
"member": "string",
|
8273
8379
|
"name": "Id",
|
@@ -8276,7 +8382,7 @@
|
|
8276
8382
|
},
|
8277
8383
|
{
|
8278
8384
|
"disabled": false,
|
8279
|
-
"document": "
|
8385
|
+
"document": "状态。1: 运行中,2: 暂停,3:错误",
|
8280
8386
|
"example": "1",
|
8281
8387
|
"member": "uint64",
|
8282
8388
|
"name": "Status",
|
@@ -8470,7 +8576,7 @@
|
|
8470
8576
|
},
|
8471
8577
|
{
|
8472
8578
|
"disabled": false,
|
8473
|
-
"document": "
|
8579
|
+
"document": "检索分析语句。\n语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。\n使用*或空字符串可查询所有日志。",
|
8474
8580
|
"example": "http_status:200",
|
8475
8581
|
"member": "string",
|
8476
8582
|
"name": "Query",
|
@@ -8479,7 +8585,7 @@
|
|
8479
8585
|
},
|
8480
8586
|
{
|
8481
8587
|
"disabled": false,
|
8482
|
-
"document": "要查询的日志主题ID",
|
8588
|
+
"document": "要查询的日志主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
8483
8589
|
"example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
|
8484
8590
|
"member": "string",
|
8485
8591
|
"name": "TopicId",
|
@@ -8619,8 +8725,8 @@
|
|
8619
8725
|
"members": [
|
8620
8726
|
{
|
8621
8727
|
"disabled": false,
|
8622
|
-
"document": "机器组ID",
|
8623
|
-
"example": "
|
8728
|
+
"document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
|
8729
|
+
"example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
|
8624
8730
|
"member": "string",
|
8625
8731
|
"name": "GroupId",
|
8626
8732
|
"required": true,
|
@@ -8656,7 +8762,7 @@
|
|
8656
8762
|
"members": [
|
8657
8763
|
{
|
8658
8764
|
"disabled": false,
|
8659
|
-
"document": "
|
8765
|
+
"document": "过滤条件\nmachineGroupName\n- 按照【机器组名称】进行过滤。\n- 类型:String\n- 必选:否\n\nmachineGroupId\n- 按照【机器组ID】进行过滤。\n- 类型:String\n- 必选:否\n\nosType\n- 按照【操作系统类型】进行过滤。0: Linux;1: Windows\n- 类型:Int\n- 必选:否\n\ntagKey\n- 按照【标签键】进行过滤。\n- 类型:String\n- 必选:否\n\ntag:tagKey\n- 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。\n- 类型:String\n- 必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
|
8660
8766
|
"example": "无",
|
8661
8767
|
"member": "Filter",
|
8662
8768
|
"name": "Filters",
|
@@ -8910,8 +9016,8 @@
|
|
8910
9016
|
"members": [
|
8911
9017
|
{
|
8912
9018
|
"disabled": false,
|
8913
|
-
"document": "日志主题
|
8914
|
-
"example": "
|
9019
|
+
"document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
9020
|
+
"example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
|
8915
9021
|
"member": "string",
|
8916
9022
|
"name": "TopicId",
|
8917
9023
|
"required": true,
|
@@ -8975,7 +9081,7 @@
|
|
8975
9081
|
{
|
8976
9082
|
"disabled": false,
|
8977
9083
|
"document": "任务id。",
|
8978
|
-
"example": "
|
9084
|
+
"example": "9c64f9c1-a14e-4b59-b074-5b73cac3dd66",
|
8979
9085
|
"member": "string",
|
8980
9086
|
"name": "TaskId",
|
8981
9087
|
"required": false,
|
@@ -8983,7 +9089,7 @@
|
|
8983
9089
|
},
|
8984
9090
|
{
|
8985
9091
|
"disabled": false,
|
8986
|
-
"document": "
|
9092
|
+
"document": "- srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。\n- dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。\n- srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。\n- dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。\n- bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否\n- status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否\n- taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。\n- taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。",
|
8987
9093
|
"example": "无",
|
8988
9094
|
"member": "Filter",
|
8989
9095
|
"name": "Filters",
|
@@ -9159,7 +9265,7 @@
|
|
9159
9265
|
"members": [
|
9160
9266
|
{
|
9161
9267
|
"disabled": false,
|
9162
|
-
"document": "<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>\n<li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets
|
9268
|
+
"document": "<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>\n<li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>\n<li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href=\"https://cloud.tencent.com/document/product/614/58624\">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href=\"https://cloud.tencent.com/document/product/614/58626\">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>\n<li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>\n<li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>\n<li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>\n注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为100。",
|
9163
9269
|
"example": "无",
|
9164
9270
|
"member": "Filter",
|
9165
9271
|
"name": "Filters",
|
@@ -9242,7 +9348,7 @@
|
|
9242
9348
|
"members": [
|
9243
9349
|
{
|
9244
9350
|
"disabled": false,
|
9245
|
-
"document": "- name\n按照【告警渠道回调配置名称】进行过滤。\n类型:String\n必选:否\n\n- webCallbackId\n按照【告警渠道回调配置ID】进行过滤。\n类型:String\n必选:否\n\n- type\n按照【告警渠道回调配置渠道类型】进行过滤。\n类型:String\n必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为100。",
|
9351
|
+
"document": "- name\n按照【告警渠道回调配置名称】进行过滤。\n类型:String\n必选:否\n\n- webCallbackId\n按照【告警渠道回调配置ID】进行过滤。\n类型:String\n必选:否\n\n- type\n按照【告警渠道回调配置渠道类型】进行过滤。\n类型:String\n必选:否\n枚举值:WeCom,DingTalk,Lark,Http\n每次请求的Filters的上限为10,Filter.Values的上限为100。",
|
9246
9352
|
"example": "无",
|
9247
9353
|
"member": "Filter",
|
9248
9354
|
"name": "Filters",
|
@@ -9407,7 +9513,7 @@
|
|
9407
9513
|
},
|
9408
9514
|
{
|
9409
9515
|
"disabled": false,
|
9410
|
-
"document": "
|
9516
|
+
"document": "时间字段(Timestamp)支持的类型\n- 1(用户自定义时间)\n- 2(当前时间)",
|
9411
9517
|
"example": "1",
|
9412
9518
|
"member": "uint64",
|
9413
9519
|
"name": "TimeType",
|
@@ -9418,8 +9524,8 @@
|
|
9418
9524
|
},
|
9419
9525
|
{
|
9420
9526
|
"disabled": false,
|
9421
|
-
"document": "
|
9422
|
-
"example": "
|
9527
|
+
"document": "时间,用户选择自定义时间类型时,需要指定时间,单位秒\n格式:时间戳,1754897446",
|
9528
|
+
"example": "1754897446",
|
9423
9529
|
"member": "uint64",
|
9424
9530
|
"name": "Timestamp",
|
9425
9531
|
"output_required": true,
|
@@ -9564,7 +9670,7 @@
|
|
9564
9670
|
},
|
9565
9671
|
{
|
9566
9672
|
"disabled": false,
|
9567
|
-
"document": "
|
9673
|
+
"document": "日志导出起始时间,毫秒时间戳",
|
9568
9674
|
"example": "1607499207000",
|
9569
9675
|
"member": "int64",
|
9570
9676
|
"name": "From",
|
@@ -9574,7 +9680,7 @@
|
|
9574
9680
|
},
|
9575
9681
|
{
|
9576
9682
|
"disabled": false,
|
9577
|
-
"document": "
|
9683
|
+
"document": "日志导出结束时间,毫秒时间戳",
|
9578
9684
|
"example": "1607499208000",
|
9579
9685
|
"member": "int64",
|
9580
9686
|
"name": "To",
|
@@ -9594,7 +9700,7 @@
|
|
9594
9700
|
},
|
9595
9701
|
{
|
9596
9702
|
"disabled": false,
|
9597
|
-
"document": "
|
9703
|
+
"document": "日志导出创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
|
9598
9704
|
"example": "2020-08-08 12:12:12",
|
9599
9705
|
"member": "string",
|
9600
9706
|
"name": "CreateTime",
|
@@ -9615,7 +9721,7 @@
|
|
9615
9721
|
{
|
9616
9722
|
"disabled": false,
|
9617
9723
|
"document": "导出字段",
|
9618
|
-
"example": "[\"__timestamp__\"
|
9724
|
+
"example": "[\"__timestamp__\"]",
|
9619
9725
|
"member": "string",
|
9620
9726
|
"name": "DerivedFields",
|
9621
9727
|
"output_required": false,
|
@@ -9630,7 +9736,7 @@
|
|
9630
9736
|
"members": [
|
9631
9737
|
{
|
9632
9738
|
"disabled": false,
|
9633
|
-
"document": "时间字段的key名字,
|
9739
|
+
"document": "时间字段的key名字,TimeKey和TimeFormat必须成对出现",
|
9634
9740
|
"example": "time",
|
9635
9741
|
"member": "string",
|
9636
9742
|
"name": "TimeKey",
|
@@ -9641,8 +9747,8 @@
|
|
9641
9747
|
},
|
9642
9748
|
{
|
9643
9749
|
"disabled": false,
|
9644
|
-
"document": "时间字段的格式,参考c语言的strftime
|
9645
|
-
"example": "
|
9750
|
+
"document": "时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数\n- 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档 ",
|
9751
|
+
"example": "%Y-%m-%d %H:%M:%S",
|
9646
9752
|
"member": "string",
|
9647
9753
|
"name": "TimeFormat",
|
9648
9754
|
"output_required": true,
|
@@ -9730,7 +9836,7 @@
|
|
9730
9836
|
{
|
9731
9837
|
"disabled": false,
|
9732
9838
|
"document": "增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。\n注意:\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
|
9733
|
-
"example": "
|
9839
|
+
"example": "0",
|
9734
9840
|
"member": "int64",
|
9735
9841
|
"name": "Backtracking",
|
9736
9842
|
"output_required": true,
|
@@ -9999,7 +10105,7 @@
|
|
9999
10105
|
},
|
10000
10106
|
{
|
10001
10107
|
"disabled": false,
|
10002
|
-
"document": "查询过滤条件,例如:\n- 按告警策略ID查询:`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971\"`\n- 按监控对象ID查询:`monitored_object:\"823d8bfa-76a7-xxxx-8399-8cda74d4009b\" `\n- 按告警策略ID及监控对象ID查询:`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971\" AND monitored_object:\"823d8bfa-76a7-xxxx-8399-8cda74d4009b\"`\n- 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:\"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c\") AND (monitored_object:\"3c514e84-6f1f-46ec-xxxx-05de6163f7fe\") AND NOT condition_evaluate_result: \"Skip\" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`",
|
10108
|
+
"document": "查询过滤条件,例如:\n- 按告警策略ID查询:`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971\"`\n - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID\n- 按监控对象ID查询:`monitored_object:\"823d8bfa-76a7-xxxx-8399-8cda74d4009b\" `\n - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID\n- 按告警策略ID及监控对象ID查询:`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971\" AND monitored_object:\"823d8bfa-76a7-xxxx-8399-8cda74d4009b\"`\n- 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:\"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c\") AND (monitored_object:\"3c514e84-6f1f-46ec-xxxx-05de6163f7fe\") AND NOT condition_evaluate_result: \"Skip\" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`",
|
10003
10109
|
"example": "alert_id:notice-c0960eb3-6454-4eef-xxxx-8feb766a9fbd",
|
10004
10110
|
"member": "string",
|
10005
10111
|
"name": "Query",
|
@@ -10071,7 +10177,7 @@
|
|
10071
10177
|
{
|
10072
10178
|
"disabled": false,
|
10073
10179
|
"document": "返回的结果是否为SQL分析结果",
|
10074
|
-
"example": "
|
10180
|
+
"example": "true",
|
10075
10181
|
"member": "bool",
|
10076
10182
|
"name": "Analysis",
|
10077
10183
|
"output_required": true,
|
@@ -10111,7 +10217,7 @@
|
|
10111
10217
|
{
|
10112
10218
|
"disabled": false,
|
10113
10219
|
"document": "执行详情统计分析结果;UseNewAnalysis为true有效。\n注意:此字段可能返回 null,表示取不到有效值。",
|
10114
|
-
"example": "[\"
|
10220
|
+
"example": "[\"acd\",\"ac\"]",
|
10115
10221
|
"member": "string",
|
10116
10222
|
"name": "AnalysisRecords",
|
10117
10223
|
"output_required": true,
|
@@ -10200,17 +10306,17 @@
|
|
10200
10306
|
"example": "15",
|
10201
10307
|
"member": "int64",
|
10202
10308
|
"name": "Count",
|
10203
|
-
"
|
10309
|
+
"output_required": true,
|
10204
10310
|
"type": "int",
|
10205
10311
|
"value_allowed_null": false
|
10206
10312
|
},
|
10207
10313
|
{
|
10208
10314
|
"disabled": false,
|
10209
10315
|
"document": "按 period 取整后的 unix timestamp: 单位毫秒",
|
10210
|
-
"example": "
|
10316
|
+
"example": "1754856576000",
|
10211
10317
|
"member": "int64",
|
10212
10318
|
"name": "BTime",
|
10213
|
-
"
|
10319
|
+
"output_required": true,
|
10214
10320
|
"type": "int",
|
10215
10321
|
"value_allowed_null": false
|
10216
10322
|
}
|
@@ -10361,7 +10467,7 @@
|
|
10361
10467
|
"members": [
|
10362
10468
|
{
|
10363
10469
|
"disabled": false,
|
10364
|
-
"document": "协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。\n
|
10470
|
+
"document": "协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。\n\n- 当IsEncryptionAddr为true时,Protocol必填。\n- 支持的协议类型如下:\n - plaintext:纯文本无加密协议\n - sasl_ssl:SASL 认证 + SSL 加密\n - ssl:纯 SSL/TLS 加密协议\n - sasl_plaintext:SASL 认证 + 非加密通道\n",
|
10365
10471
|
"example": "sasl_ssl",
|
10366
10472
|
"member": "string",
|
10367
10473
|
"name": "Protocol",
|
@@ -10372,7 +10478,7 @@
|
|
10372
10478
|
},
|
10373
10479
|
{
|
10374
10480
|
"disabled": false,
|
10375
|
-
"document": "加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。\n当Protocol为sasl_plaintext或sasl_ssl
|
10481
|
+
"document": "加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。\n\n- 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。\n- 支持加密类型如下\n - PLAIN:明文认证\n - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法\n - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法",
|
10376
10482
|
"example": "PLAIN",
|
10377
10483
|
"member": "string",
|
10378
10484
|
"name": "Mechanism",
|
@@ -10919,7 +11025,7 @@
|
|
10919
11025
|
},
|
10920
11026
|
{
|
10921
11027
|
"disabled": false,
|
10922
|
-
"document": "
|
11028
|
+
"document": "使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true",
|
10923
11029
|
"example": "true",
|
10924
11030
|
"member": "bool",
|
10925
11031
|
"name": "DefaultTimeSwitch",
|
@@ -10985,7 +11091,7 @@
|
|
10985
11091
|
},
|
10986
11092
|
{
|
10987
11093
|
"disabled": false,
|
10988
|
-
"document": "
|
11094
|
+
"document": "时间字段,日志中代表时间的字段名。\n\n- 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。",
|
10989
11095
|
"example": "__TIMESTAMP__",
|
10990
11096
|
"member": "string",
|
10991
11097
|
"name": "TimeKey",
|
@@ -10996,7 +11102,7 @@
|
|
10996
11102
|
},
|
10997
11103
|
{
|
10998
11104
|
"disabled": false,
|
10999
|
-
"document": "
|
11105
|
+
"document": "时间提取正则表达式。\n- 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。\n- 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。\n 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\\d\\d\\d\\d-\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d\n",
|
11000
11106
|
"example": "(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})",
|
11001
11107
|
"member": "string",
|
11002
11108
|
"name": "TimeRegex",
|
@@ -11007,7 +11113,7 @@
|
|
11007
11113
|
},
|
11008
11114
|
{
|
11009
11115
|
"disabled": false,
|
11010
|
-
"document": "
|
11116
|
+
"document": "时间字段格式。\n- 当DefaultTimeSwitch为false时, TimeFormat不能为空。",
|
11011
11117
|
"example": "%Y-%m-%d %H:%M:%S",
|
11012
11118
|
"member": "string",
|
11013
11119
|
"name": "TimeFormat",
|
@@ -11018,7 +11124,7 @@
|
|
11018
11124
|
},
|
11019
11125
|
{
|
11020
11126
|
"disabled": false,
|
11021
|
-
"document": "
|
11127
|
+
"document": "时间字段时区。\n- 当DefaultTimeSwitch为false时, TimeZone不能为空。\n- 时区格式规则\n前缀:使用 GMT 或 UTC 作为时区基准\n偏移量:\n - `-` 表示西时区(比基准时间晚)\n - `+` 表示东时区(比基准时间早)\n - 格式为 ±HH:MM(小时:分钟)\n\n- 当前支持:\n```\n\"GMT-12:00\" \n\"GMT-11:00\" \n\"GMT-10:00\" \n\"GMT-09:30\" \n\"GMT-09:00\" \n\"GMT-08:00\" \n\"GMT-07:00\" \n\"GMT-06:00\" \n\"GMT-05:00\" \n\"GMT-04:00\" \n\"GMT-03:30\" \n\"GMT-03:00\" \n\"GMT-02:00\" \n\"GMT-01:00\" \n\"GMT+00:00\"\n\"GMT+01:00\"\n\"GMT+02:00\"\n\"GMT+03:30\"\n\"GMT+04:00\"\n\"GMT+04:30\"\n\"GMT+05:00\"\n\"GMT+05:30\"\n\"GMT+05:45\"\n\"GMT+06:00\"\n\"GMT+06:30\"\n\"GMT+07:00\"\n\"GMT+08:00\"\n\"GMT+09:00\"\n\"GMT+09:30\"\n\"GMT+10:00\"\n\"GMT+10:30\"\n\"GMT+11:00\"\n\"GMT+11:30\"\n\"GMT+12:00\"\n\"GMT+12:45\"\n\"GMT+13:00\"\n\"GMT+14:00\"\n\"UTC-11:00\"\n\"UTC-10:00\"\n\"UTC-09:00\"\n\"UTC-08:00\"\n\"UTC-12:00\"\n\"UTC-07:00\"\n\"UTC-06:00\"\n\"UTC-05:00\"\n\"UTC-04:30\"\n\"UTC-04:00\"\n\"UTC-03:30\"\n\"UTC-03:00\"\n\"UTC-02:00\"\n\"UTC-01:00\"\n\"UTC+00:00\"\n\"UTC+01:00\"\n\"UTC+02:00\"\n\"UTC+03:00\"\n\"UTC+03:30\"\n\"UTC+04:00\"\n\"UTC+04:30\"\n\"UTC+05:00\"\n\"UTC+05:45\"\n\"UTC+06:00\"\n\"UTC+06:30\"\n\"UTC+07:00\"\n\"UTC+08:00\"\n\"UTC+09:00\"\n\"UTC+09:30\"\n\"UTC+10:00\"\n\"UTC+11:00\"\n\"UTC+12:00\"\n\"UTC+13:00\"\n```",
|
11022
11128
|
"example": "UTC+08:00",
|
11023
11129
|
"member": "string",
|
11024
11130
|
"name": "TimeZone",
|
@@ -11174,7 +11280,7 @@
|
|
11174
11280
|
},
|
11175
11281
|
{
|
11176
11282
|
"disabled": false,
|
11177
|
-
"document": "
|
11283
|
+
"document": "创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
|
11178
11284
|
"example": "2021-03-05 00:40:22",
|
11179
11285
|
"member": "string",
|
11180
11286
|
"name": "CreateTime",
|
@@ -11204,7 +11310,7 @@
|
|
11204
11310
|
},
|
11205
11311
|
{
|
11206
11312
|
"disabled": false,
|
11207
|
-
"document": "升级开始时间,建议业务低峰期升级LogListener",
|
11313
|
+
"document": "升级开始时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
11208
11314
|
"example": "\"12:00:00\"",
|
11209
11315
|
"member": "string",
|
11210
11316
|
"name": "UpdateStartTime",
|
@@ -11214,7 +11320,7 @@
|
|
11214
11320
|
},
|
11215
11321
|
{
|
11216
11322
|
"disabled": false,
|
11217
|
-
"document": "升级结束时间,建议业务低峰期升级LogListener",
|
11323
|
+
"document": "升级结束时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
11218
11324
|
"example": "\"13:00:00\"",
|
11219
11325
|
"member": "string",
|
11220
11326
|
"name": "UpdateEndTime",
|
@@ -11234,7 +11340,7 @@
|
|
11234
11340
|
},
|
11235
11341
|
{
|
11236
11342
|
"disabled": false,
|
11237
|
-
"document": "
|
11343
|
+
"document": "机器组中机器离线定期清理时间,单位天,默认设置30天。",
|
11238
11344
|
"example": "30",
|
11239
11345
|
"member": "int64",
|
11240
11346
|
"name": "DelayCleanupTime",
|
@@ -11394,7 +11500,7 @@
|
|
11394
11500
|
"members": [
|
11395
11501
|
{
|
11396
11502
|
"disabled": false,
|
11397
|
-
"document": "日志主题
|
11503
|
+
"document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
11398
11504
|
"example": "427bba81-e149-4a8b-bd0d-b2a412520d7b",
|
11399
11505
|
"member": "string",
|
11400
11506
|
"name": "TopicId",
|
@@ -11403,7 +11509,7 @@
|
|
11403
11509
|
},
|
11404
11510
|
{
|
11405
11511
|
"disabled": false,
|
11406
|
-
"document": "合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(
|
11512
|
+
"document": "合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)\n\n1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);\n2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);\n3. topic的分区数量是有限制的(默认50个),合并之后不能超过最大分区,否则不能合并。",
|
11407
11513
|
"example": "2",
|
11408
11514
|
"member": "int64",
|
11409
11515
|
"name": "PartitionId",
|
@@ -11496,7 +11602,7 @@
|
|
11496
11602
|
"members": [
|
11497
11603
|
{
|
11498
11604
|
"disabled": false,
|
11499
|
-
"document": "通知渠道组ID
|
11605
|
+
"document": "通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID",
|
11500
11606
|
"example": "notice-5b2ea996-4dae-47cc-bbad-5b12888b4c89",
|
11501
11607
|
"member": "string",
|
11502
11608
|
"name": "AlarmNoticeId",
|
@@ -11613,7 +11719,7 @@
|
|
11613
11719
|
"members": [
|
11614
11720
|
{
|
11615
11721
|
"disabled": false,
|
11616
|
-
"document": "告警策略ID
|
11722
|
+
"document": "告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID",
|
11617
11723
|
"example": "alarm-bea71170-4a59-11eb-b378-0242ac130002",
|
11618
11724
|
"member": "string",
|
11619
11725
|
"name": "AlarmId",
|
@@ -11622,7 +11728,7 @@
|
|
11622
11728
|
},
|
11623
11729
|
{
|
11624
11730
|
"disabled": false,
|
11625
|
-
"document": "
|
11731
|
+
"document": "告警策略名称。最大支持255个字节,不支持 '|'。",
|
11626
11732
|
"example": "访问拦截告警",
|
11627
11733
|
"member": "string",
|
11628
11734
|
"name": "Name",
|
@@ -11640,7 +11746,7 @@
|
|
11640
11746
|
},
|
11641
11747
|
{
|
11642
11748
|
"disabled": false,
|
11643
|
-
"document": "
|
11749
|
+
"document": "告警信息发送的触发条件。\n\n注意: \n- Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。",
|
11644
11750
|
"example": "$1.source='10.0.0.1'",
|
11645
11751
|
"member": "string",
|
11646
11752
|
"name": "Condition",
|
@@ -11685,7 +11791,7 @@
|
|
11685
11791
|
},
|
11686
11792
|
{
|
11687
11793
|
"disabled": false,
|
11688
|
-
"document": "
|
11794
|
+
"document": "关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表",
|
11689
11795
|
"example": "[\"notice-479dec34-4a59-11eb-b378-0242ac130002\"]",
|
11690
11796
|
"member": "string",
|
11691
11797
|
"name": "AlarmNoticeIds",
|
@@ -11811,7 +11917,7 @@
|
|
11811
11917
|
"members": [
|
11812
11918
|
{
|
11813
11919
|
"disabled": false,
|
11814
|
-
"document": "屏蔽规则ID
|
11920
|
+
"document": "屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID",
|
11815
11921
|
"example": "cb37f589-6232-431a-xxxx-e2b61fb375d1",
|
11816
11922
|
"member": "string",
|
11817
11923
|
"name": "TaskId",
|
@@ -11820,7 +11926,7 @@
|
|
11820
11926
|
},
|
11821
11927
|
{
|
11822
11928
|
"disabled": false,
|
11823
|
-
"document": "通知渠道组id
|
11929
|
+
"document": "通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id",
|
11824
11930
|
"example": "notice-bb42f112-xxxx-456e-b3c4-ff5472911b42",
|
11825
11931
|
"member": "string",
|
11826
11932
|
"name": "AlarmNoticeId",
|
@@ -11829,7 +11935,7 @@
|
|
11829
11935
|
},
|
11830
11936
|
{
|
11831
11937
|
"disabled": false,
|
11832
|
-
"document": "
|
11938
|
+
"document": "屏蔽开始时间,秒级(s)时间戳。",
|
11833
11939
|
"example": "1701872657",
|
11834
11940
|
"member": "uint64",
|
11835
11941
|
"name": "StartTime",
|
@@ -11838,7 +11944,7 @@
|
|
11838
11944
|
},
|
11839
11945
|
{
|
11840
11946
|
"disabled": false,
|
11841
|
-
"document": "
|
11947
|
+
"document": "屏蔽结束时间,秒级(s)时间戳。",
|
11842
11948
|
"example": "1701883657",
|
11843
11949
|
"member": "uint64",
|
11844
11950
|
"name": "EndTime",
|
@@ -11857,7 +11963,7 @@
|
|
11857
11963
|
{
|
11858
11964
|
"disabled": false,
|
11859
11965
|
"document": "屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。",
|
11860
|
-
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"
|
11966
|
+
"example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"}]}",
|
11861
11967
|
"member": "string",
|
11862
11968
|
"name": "Rule",
|
11863
11969
|
"required": false,
|
@@ -11874,7 +11980,7 @@
|
|
11874
11980
|
},
|
11875
11981
|
{
|
11876
11982
|
"disabled": false,
|
11877
|
-
"document": "规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2
|
11983
|
+
"document": "规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。\n枚举:0(未生效),1(生效中),2(已失效)",
|
11878
11984
|
"example": "2",
|
11879
11985
|
"member": "uint64",
|
11880
11986
|
"name": "Status",
|
@@ -12153,7 +12259,7 @@
|
|
12153
12259
|
},
|
12154
12260
|
{
|
12155
12261
|
"disabled": false,
|
12156
|
-
"document": "
|
12262
|
+
"document": "采集规则配置名称\n- 不能包含特殊字符|\n- 长度不能超过255字符,超过会被截断",
|
12157
12263
|
"example": "testname",
|
12158
12264
|
"member": "string",
|
12159
12265
|
"name": "Name",
|
@@ -12198,7 +12304,7 @@
|
|
12198
12304
|
},
|
12199
12305
|
{
|
12200
12306
|
"disabled": false,
|
12201
|
-
"document": "采集配置关联的日志主题(TopicId
|
12307
|
+
"document": "采集配置关联的日志主题(TopicId)\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
12202
12308
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
12203
12309
|
"member": "string",
|
12204
12310
|
"name": "Output",
|
@@ -12208,7 +12314,7 @@
|
|
12208
12314
|
{
|
12209
12315
|
"disabled": false,
|
12210
12316
|
"document": "用户自定义解析字符串,Json格式序列化的字符串。",
|
12211
|
-
"example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}
|
12317
|
+
"example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}]}\"",
|
12212
12318
|
"member": "string",
|
12213
12319
|
"name": "UserDefineRule",
|
12214
12320
|
"required": false,
|
@@ -12243,7 +12349,7 @@
|
|
12243
12349
|
"members": [
|
12244
12350
|
{
|
12245
12351
|
"disabled": false,
|
12246
|
-
"document": "
|
12352
|
+
"document": "免密分享Id。\n- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 \n- 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。",
|
12247
12353
|
"example": "13cez28h",
|
12248
12354
|
"member": "string",
|
12249
12355
|
"name": "SharingId",
|
@@ -12279,8 +12385,8 @@
|
|
12279
12385
|
"members": [
|
12280
12386
|
{
|
12281
12387
|
"disabled": false,
|
12282
|
-
"document": "投递任务绑定的日志主题
|
12283
|
-
"example": "
|
12388
|
+
"document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
12389
|
+
"example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
|
12284
12390
|
"member": "string",
|
12285
12391
|
"name": "TopicId",
|
12286
12392
|
"required": true,
|
@@ -12675,7 +12781,7 @@
|
|
12675
12781
|
"members": [
|
12676
12782
|
{
|
12677
12783
|
"disabled": false,
|
12678
|
-
"document": "日志主题
|
12784
|
+
"document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
12679
12785
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
12680
12786
|
"member": "string",
|
12681
12787
|
"name": "FromTopicId",
|
@@ -12684,7 +12790,7 @@
|
|
12684
12790
|
},
|
12685
12791
|
{
|
12686
12792
|
"disabled": false,
|
12687
|
-
"document": "
|
12793
|
+
"document": "压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩",
|
12688
12794
|
"example": "2",
|
12689
12795
|
"member": "int64",
|
12690
12796
|
"name": "Compression",
|
@@ -12720,7 +12826,7 @@
|
|
12720
12826
|
"members": [
|
12721
12827
|
{
|
12722
12828
|
"disabled": false,
|
12723
|
-
"document": "Kafka导入配置
|
12829
|
+
"document": "导入配置Id。\n- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。\n- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。",
|
12724
12830
|
"example": "1014cc79-f006-48e4-8820-1dc7270540c0",
|
12725
12831
|
"member": "string",
|
12726
12832
|
"name": "Id",
|
@@ -12729,7 +12835,7 @@
|
|
12729
12835
|
},
|
12730
12836
|
{
|
12731
12837
|
"disabled": false,
|
12732
|
-
"document": "导入CLS目标
|
12838
|
+
"document": "导入CLS目标TopicId。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。",
|
12733
12839
|
"example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
|
12734
12840
|
"member": "string",
|
12735
12841
|
"name": "TopicId",
|
@@ -12756,7 +12862,7 @@
|
|
12756
12862
|
},
|
12757
12863
|
{
|
12758
12864
|
"disabled": false,
|
12759
|
-
"document": "腾讯云CKafka实例ID,KafkaType为0
|
12865
|
+
"document": "腾讯云CKafka实例ID,KafkaType为0时必填。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。",
|
12760
12866
|
"example": "ckafka-2vrgxbxa",
|
12761
12867
|
"member": "string",
|
12762
12868
|
"name": "KafkaInstance",
|
@@ -12792,7 +12898,7 @@
|
|
12792
12898
|
},
|
12793
12899
|
{
|
12794
12900
|
"disabled": false,
|
12795
|
-
"document": "用户需要导入的Kafka相关topic列表,多个topic
|
12901
|
+
"document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。\n\n- Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。",
|
12796
12902
|
"example": "topic-subs-0px4qkvu32-cdb-5zi7jf11",
|
12797
12903
|
"member": "string",
|
12798
12904
|
"name": "UserKafkaTopics",
|
@@ -12819,7 +12925,7 @@
|
|
12819
12925
|
},
|
12820
12926
|
{
|
12821
12927
|
"disabled": false,
|
12822
|
-
"document": "导入控制,1:暂停;2
|
12928
|
+
"document": "导入控制,1:暂停;2:启动。",
|
12823
12929
|
"example": "1",
|
12824
12930
|
"member": "uint64",
|
12825
12931
|
"name": "StatusControl",
|
@@ -12891,7 +12997,7 @@
|
|
12891
12997
|
"members": [
|
12892
12998
|
{
|
12893
12999
|
"disabled": false,
|
12894
|
-
"document": "机器组
|
13000
|
+
"document": "机器组Id\n- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。",
|
12895
13001
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
12896
13002
|
"member": "string",
|
12897
13003
|
"name": "GroupId",
|
@@ -12900,7 +13006,7 @@
|
|
12900
13006
|
},
|
12901
13007
|
{
|
12902
13008
|
"disabled": false,
|
12903
|
-
"document": "
|
13009
|
+
"document": "机器组名称\n输入限制:\n- 不能为空字符串\n- 不能包含字符'|'",
|
12904
13010
|
"example": "testname",
|
12905
13011
|
"member": "string",
|
12906
13012
|
"name": "GroupName",
|
@@ -12936,7 +13042,7 @@
|
|
12936
13042
|
},
|
12937
13043
|
{
|
12938
13044
|
"disabled": false,
|
12939
|
-
"document": "升级开始时间,建议业务低峰期升级LogListener",
|
13045
|
+
"document": "升级开始时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
12940
13046
|
"example": "\"12:00:00\"",
|
12941
13047
|
"member": "string",
|
12942
13048
|
"name": "UpdateStartTime",
|
@@ -12945,7 +13051,7 @@
|
|
12945
13051
|
},
|
12946
13052
|
{
|
12947
13053
|
"disabled": false,
|
12948
|
-
"document": "升级结束时间,建议业务低峰期升级LogListener",
|
13054
|
+
"document": "升级结束时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
|
12949
13055
|
"example": "\"13:00:00\"",
|
12950
13056
|
"member": "string",
|
12951
13057
|
"name": "UpdateEndTime",
|
@@ -12999,7 +13105,7 @@
|
|
12999
13105
|
"members": [
|
13000
13106
|
{
|
13001
13107
|
"disabled": false,
|
13002
|
-
"document": "通知内容模板ID
|
13108
|
+
"document": "通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID",
|
13003
13109
|
"example": "noticetemplate-5b2ea996-4dae-47cc-bbad-5b12888b4c89",
|
13004
13110
|
"member": "string",
|
13005
13111
|
"name": "NoticeContentId",
|
@@ -13053,7 +13159,7 @@
|
|
13053
13159
|
"members": [
|
13054
13160
|
{
|
13055
13161
|
"disabled": false,
|
13056
|
-
"document": "任务ID",
|
13162
|
+
"document": "任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
|
13057
13163
|
"example": "6ef60bec-0242-43af-bb20-270359fxxxx",
|
13058
13164
|
"member": "string",
|
13059
13165
|
"name": "TaskId",
|
@@ -13062,7 +13168,7 @@
|
|
13062
13168
|
},
|
13063
13169
|
{
|
13064
13170
|
"disabled": false,
|
13065
|
-
"document": "
|
13171
|
+
"document": "源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
|
13066
13172
|
"example": "xxxx-0889-4ec0-accc-xxxxxxx",
|
13067
13173
|
"member": "string",
|
13068
13174
|
"name": "SrcTopicId",
|
@@ -13098,7 +13204,7 @@
|
|
13098
13204
|
},
|
13099
13205
|
{
|
13100
13206
|
"disabled": false,
|
13101
|
-
"document": "调度周期(分钟)",
|
13207
|
+
"document": "调度周期(分钟),1~1440分钟",
|
13102
13208
|
"example": "2",
|
13103
13209
|
"member": "int64",
|
13104
13210
|
"name": "ProcessPeriod",
|
@@ -13116,7 +13222,7 @@
|
|
13116
13222
|
},
|
13117
13223
|
{
|
13118
13224
|
"disabled": false,
|
13119
|
-
"document": "执行延迟(秒)",
|
13225
|
+
"document": "执行延迟(秒),0~120秒,默认60秒",
|
13120
13226
|
"example": "60",
|
13121
13227
|
"member": "int64",
|
13122
13228
|
"name": "ProcessDelay",
|
@@ -13125,7 +13231,7 @@
|
|
13125
13231
|
},
|
13126
13232
|
{
|
13127
13233
|
"disabled": false,
|
13128
|
-
"document": "源topicId
|
13234
|
+
"document": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档",
|
13129
13235
|
"example": "ap-guangzhou",
|
13130
13236
|
"member": "string",
|
13131
13237
|
"name": "SrcTopicRegion",
|
@@ -13134,7 +13240,7 @@
|
|
13134
13240
|
},
|
13135
13241
|
{
|
13136
13242
|
"disabled": false,
|
13137
|
-
"document": "
|
13243
|
+
"document": "任务名称,0~255字符",
|
13138
13244
|
"example": "scheduler_sql任务1",
|
13139
13245
|
"member": "string",
|
13140
13246
|
"name": "Name",
|
@@ -13305,8 +13411,8 @@
|
|
13305
13411
|
"members": [
|
13306
13412
|
{
|
13307
13413
|
"disabled": false,
|
13308
|
-
"document": "日志主题ID",
|
13309
|
-
"example": "
|
13414
|
+
"document": "日志主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
13415
|
+
"example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
|
13310
13416
|
"member": "string",
|
13311
13417
|
"name": "TopicId",
|
13312
13418
|
"required": true,
|
@@ -13314,7 +13420,7 @@
|
|
13314
13420
|
},
|
13315
13421
|
{
|
13316
13422
|
"disabled": false,
|
13317
|
-
"document": "
|
13423
|
+
"document": "日志主题名称\n输入限制:\n- 不能为空字符串\n- 不能包含字符'|'\n- 不能使用以下名称[\"cls_service_log\",\"loglistener_status\",\"loglistener_alarm\",\"loglistener_business\",\"cls_service_metric\"]",
|
13318
13424
|
"example": "testname",
|
13319
13425
|
"member": "string",
|
13320
13426
|
"name": "TopicName",
|
@@ -13350,7 +13456,7 @@
|
|
13350
13456
|
},
|
13351
13457
|
{
|
13352
13458
|
"disabled": false,
|
13353
|
-
"document": "
|
13459
|
+
"document": "若开启最大分裂,该主题能够能够允许的最大分区数;\n默认为50;必须为正数",
|
13354
13460
|
"example": "50",
|
13355
13461
|
"member": "int64",
|
13356
13462
|
"name": "MaxSplitPartitions",
|
@@ -13404,7 +13510,7 @@
|
|
13404
13510
|
},
|
13405
13511
|
{
|
13406
13512
|
"disabled": false,
|
13407
|
-
"document": "
|
13513
|
+
"document": "日志主题分区数量。\n默认为1;\n取值范围及约束:\n- 当输入值<=0,系统自动调整为1。\n- 如果未传MaxSplitPartitions,需要PartitionCount<=50;\n- 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;",
|
13408
13514
|
"example": "10",
|
13409
13515
|
"member": "uint64",
|
13410
13516
|
"name": "PartitionCount",
|
@@ -13413,7 +13519,7 @@
|
|
13413
13519
|
},
|
13414
13520
|
{
|
13415
13521
|
"disabled": false,
|
13416
|
-
"document": "取消切换存储任务的id",
|
13522
|
+
"document": "取消切换存储任务的id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。",
|
13417
13523
|
"example": "87b94286-1b33-44df-8568-924eb250ef4e",
|
13418
13524
|
"member": "string",
|
13419
13525
|
"name": "CancelTopicAsyncTaskID",
|
@@ -13440,7 +13546,7 @@
|
|
13440
13546
|
"members": [
|
13441
13547
|
{
|
13442
13548
|
"disabled": false,
|
13443
|
-
"document": "告警渠道回调配置ID
|
13549
|
+
"document": "告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID",
|
13444
13550
|
"example": "webcallback-5b2ea996-xxxx-xxxx-bbad-5b12888b4c89",
|
13445
13551
|
"member": "string",
|
13446
13552
|
"name": "WebCallbackId",
|
@@ -13449,7 +13555,7 @@
|
|
13449
13555
|
},
|
13450
13556
|
{
|
13451
13557
|
"disabled": false,
|
13452
|
-
"document": "
|
13558
|
+
"document": "告警渠道回调配置名称。最大支持255个字节",
|
13453
13559
|
"example": "监控告警专用",
|
13454
13560
|
"member": "string",
|
13455
13561
|
"name": "Name",
|
@@ -13485,7 +13591,7 @@
|
|
13485
13591
|
},
|
13486
13592
|
{
|
13487
13593
|
"disabled": false,
|
13488
|
-
"document": "
|
13594
|
+
"document": "秘钥信息。最大支持1024个字节",
|
13489
13595
|
"example": "HASFUBRINFYAWERNTFGPI",
|
13490
13596
|
"member": "string",
|
13491
13597
|
"name": "Key",
|
@@ -13534,7 +13640,7 @@
|
|
13534
13640
|
},
|
13535
13641
|
{
|
13536
13642
|
"disabled": false,
|
13537
|
-
"document": "执行的周期cron表达式。示例:`\"*/1 * * * *\"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。\n当type为`Cron`时,CronExpression字段生效。",
|
13643
|
+
"document": "执行的周期cron表达式。示例:`\"*/1 * * * *\"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。\n当type为`Cron`时,CronExpression字段生效。",
|
13538
13644
|
"example": "*/1 * * * *",
|
13539
13645
|
"member": "string",
|
13540
13646
|
"name": "CronExpression",
|
@@ -13644,7 +13750,7 @@
|
|
13644
13750
|
"members": [
|
13645
13751
|
{
|
13646
13752
|
"disabled": false,
|
13647
|
-
"document": "通知内容模板标题信息。\n
|
13753
|
+
"document": "通知内容模板标题信息。\n部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。",
|
13648
13754
|
"example": "这是标题。",
|
13649
13755
|
"member": "string",
|
13650
13756
|
"name": "Title",
|
@@ -13753,7 +13859,7 @@
|
|
13753
13859
|
},
|
13754
13860
|
{
|
13755
13861
|
"disabled": false,
|
13756
|
-
"document": "创建时间
|
13862
|
+
"document": "创建时间 秒级(s)时间戳。",
|
13757
13863
|
"example": "1705923855",
|
13758
13864
|
"member": "int64",
|
13759
13865
|
"name": "CreateTime",
|
@@ -13763,7 +13869,7 @@
|
|
13763
13869
|
},
|
13764
13870
|
{
|
13765
13871
|
"disabled": false,
|
13766
|
-
"document": "更新时间
|
13872
|
+
"document": "更新时间 秒级(s)时间戳。",
|
13767
13873
|
"example": "1706149043",
|
13768
13874
|
"member": "int64",
|
13769
13875
|
"name": "UpdateTime",
|
@@ -13802,7 +13908,7 @@
|
|
13802
13908
|
{
|
13803
13909
|
"disabled": false,
|
13804
13910
|
"document": "通知接收渠道。\n- Email - 邮件\n- Sms - 短信\n- WeChat - 微信\n- Phone - 电话",
|
13805
|
-
"example": "[
|
13911
|
+
"example": "[\"Sms\"]",
|
13806
13912
|
"member": "string",
|
13807
13913
|
"name": "ReceiverChannels",
|
13808
13914
|
"output_required": true,
|
@@ -13812,7 +13918,7 @@
|
|
13812
13918
|
},
|
13813
13919
|
{
|
13814
13920
|
"disabled": false,
|
13815
|
-
"document": "通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)
|
13921
|
+
"document": "通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID",
|
13816
13922
|
"example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"",
|
13817
13923
|
"member": "string",
|
13818
13924
|
"name": "NoticeContentId",
|
@@ -13945,7 +14051,7 @@
|
|
13945
14051
|
"members": [
|
13946
14052
|
{
|
13947
14053
|
"disabled": false,
|
13948
|
-
"document": "日志主题
|
14054
|
+
"document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
|
13949
14055
|
"example": "57f5808c-4a55-11eb-b378-0242ac130002",
|
13950
14056
|
"member": "string",
|
13951
14057
|
"name": "FromTopicId",
|
@@ -14076,7 +14182,7 @@
|
|
14076
14182
|
{
|
14077
14183
|
"disabled": false,
|
14078
14184
|
"document": "分区哈希键起始key",
|
14079
|
-
"example": "
|
14185
|
+
"example": "000000000000000000000000000000f",
|
14080
14186
|
"member": "string",
|
14081
14187
|
"name": "InclusiveBeginKey",
|
14082
14188
|
"output_required": true,
|
@@ -14086,7 +14192,7 @@
|
|
14086
14192
|
{
|
14087
14193
|
"disabled": false,
|
14088
14194
|
"document": "分区哈希键结束key",
|
14089
|
-
"example": "
|
14195
|
+
"example": "0fffffffffffffffffffffffffffffff",
|
14090
14196
|
"member": "string",
|
14091
14197
|
"name": "ExclusiveEndKey",
|
14092
14198
|
"output_required": true,
|
@@ -14095,7 +14201,7 @@
|
|
14095
14201
|
},
|
14096
14202
|
{
|
14097
14203
|
"disabled": false,
|
14098
|
-
"document": "
|
14204
|
+
"document": "分区创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
|
14099
14205
|
"example": "2024-10-04 07:43:08",
|
14100
14206
|
"member": "string",
|
14101
14207
|
"name": "CreateTime",
|
@@ -14105,7 +14211,7 @@
|
|
14105
14211
|
},
|
14106
14212
|
{
|
14107
14213
|
"disabled": false,
|
14108
|
-
"document": "只读分区数据停止写入时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
14214
|
+
"document": "只读分区数据停止写入时间\n时间格式:yyyy-MM-dd HH:mm:ss\n注意:此字段可能返回 null,表示取不到有效值。",
|
14109
14215
|
"example": "2024-10-06 16:08:59",
|
14110
14216
|
"member": "string",
|
14111
14217
|
"name": "LastWriteTime",
|
@@ -14321,7 +14427,7 @@
|
|
14321
14427
|
"members": [
|
14322
14428
|
{
|
14323
14429
|
"disabled": false,
|
14324
|
-
"document": "查询语句,使用PromQL语法\t",
|
14430
|
+
"document": "查询语句,使用PromQL语法\t\n- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档",
|
14325
14431
|
"example": "access_evaluation_duration_bucket",
|
14326
14432
|
"member": "string",
|
14327
14433
|
"name": "Query",
|
@@ -14330,7 +14436,7 @@
|
|
14330
14436
|
},
|
14331
14437
|
{
|
14332
14438
|
"disabled": false,
|
14333
|
-
"document": "指标主题ID",
|
14439
|
+
"document": "指标主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
14334
14440
|
"example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f",
|
14335
14441
|
"member": "string",
|
14336
14442
|
"name": "TopicId",
|
@@ -14354,7 +14460,7 @@
|
|
14354
14460
|
"members": [
|
14355
14461
|
{
|
14356
14462
|
"disabled": false,
|
14357
|
-
"document": "
|
14463
|
+
"document": "指标查询结果类型,支持\n- scalar 标量值\n- string 字符串值\n- vector 瞬时向量\n- matrix 区间向量",
|
14358
14464
|
"example": "vector",
|
14359
14465
|
"member": "string",
|
14360
14466
|
"name": "ResultType",
|
@@ -14386,7 +14492,7 @@
|
|
14386
14492
|
"members": [
|
14387
14493
|
{
|
14388
14494
|
"disabled": false,
|
14389
|
-
"document": "指标主题ID",
|
14495
|
+
"document": "指标主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
|
14390
14496
|
"example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f",
|
14391
14497
|
"member": "string",
|
14392
14498
|
"name": "TopicId",
|
@@ -14395,7 +14501,7 @@
|
|
14395
14501
|
},
|
14396
14502
|
{
|
14397
14503
|
"disabled": false,
|
14398
|
-
"document": "查询语句,使用PromQL
|
14504
|
+
"document": "查询语句,使用PromQL语法\n- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档",
|
14399
14505
|
"example": "access_evaluation_duration_bucket",
|
14400
14506
|
"member": "string",
|
14401
14507
|
"name": "Query",
|
@@ -14437,7 +14543,7 @@
|
|
14437
14543
|
"members": [
|
14438
14544
|
{
|
14439
14545
|
"disabled": false,
|
14440
|
-
"document": "
|
14546
|
+
"document": "指标查询结果类型,支持\n- scalar 标量值\n- string 字符串值\n- vector 瞬时向量\n- matrix 区间向量",
|
14441
14547
|
"example": "matrix",
|
14442
14548
|
"member": "string",
|
14443
14549
|
"name": "ResultType",
|
@@ -14611,7 +14717,7 @@
|
|
14611
14717
|
"members": [
|
14612
14718
|
{
|
14613
14719
|
"disabled": false,
|
14614
|
-
"document": "
|
14720
|
+
"document": "通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。",
|
14615
14721
|
"example": "xxxxxxxx-0889-4ec0-accc-xxxxxxx",
|
14616
14722
|
"member": "string",
|
14617
14723
|
"name": "TopicId",
|
@@ -14622,7 +14728,7 @@
|
|
14622
14728
|
},
|
14623
14729
|
{
|
14624
14730
|
"disabled": false,
|
14625
|
-
"document": "
|
14731
|
+
"document": "主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。",
|
14626
14732
|
"example": "ap-guangzhou",
|
14627
14733
|
"member": "string",
|
14628
14734
|
"name": "Region",
|
@@ -14689,7 +14795,7 @@
|
|
14689
14795
|
{
|
14690
14796
|
"disabled": false,
|
14691
14797
|
"document": "除了MetricLabels,您还可以使用该参数,为指标补充静态的维度。\n维度名以字母或下划线开头,后面可以跟字母、数字或下划线,长度小于等于1024 字节",
|
14692
|
-
"example": "
|
14798
|
+
"example": "无",
|
14693
14799
|
"member": "MetricLabel",
|
14694
14800
|
"name": "CustomMetricLabels",
|
14695
14801
|
"output_required": false,
|
@@ -14755,7 +14861,7 @@
|
|
14755
14861
|
},
|
14756
14862
|
{
|
14757
14863
|
"disabled": false,
|
14758
|
-
"document": "
|
14864
|
+
"document": "任务创建时间。格式:yyyy-MM-dd HH:mm:ss",
|
14759
14865
|
"example": "2023-07-28 11:36:00",
|
14760
14866
|
"member": "string",
|
14761
14867
|
"name": "CreateTime",
|
@@ -14765,7 +14871,7 @@
|
|
14765
14871
|
},
|
14766
14872
|
{
|
14767
14873
|
"disabled": false,
|
14768
|
-
"document": "
|
14874
|
+
"document": "任务更新时间,格式:yyyy-MM-dd HH:mm:ss",
|
14769
14875
|
"example": "2023-07-28 11:36:00",
|
14770
14876
|
"member": "string",
|
14771
14877
|
"name": "UpdateTime",
|
@@ -14805,7 +14911,7 @@
|
|
14805
14911
|
},
|
14806
14912
|
{
|
14807
14913
|
"disabled": false,
|
14808
|
-
"document": "
|
14914
|
+
"document": "调度开始时间,格式:yyyy-MM-dd HH:mm:ss",
|
14809
14915
|
"example": "2023-07-28 11:36:00",
|
14810
14916
|
"member": "string",
|
14811
14917
|
"name": "ProcessStartTime",
|
@@ -14825,7 +14931,7 @@
|
|
14825
14931
|
},
|
14826
14932
|
{
|
14827
14933
|
"disabled": false,
|
14828
|
-
"document": "
|
14934
|
+
"document": "调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段",
|
14829
14935
|
"example": "2023-07-28 11:36:00",
|
14830
14936
|
"member": "string",
|
14831
14937
|
"name": "ProcessEndTime",
|
@@ -14835,7 +14941,7 @@
|
|
14835
14941
|
},
|
14836
14942
|
{
|
14837
14943
|
"disabled": false,
|
14838
|
-
"document": "调度周期(分钟)",
|
14944
|
+
"document": "调度周期(分钟),1~1440分钟",
|
14839
14945
|
"example": "5",
|
14840
14946
|
"member": "int64",
|
14841
14947
|
"name": "ProcessPeriod",
|
@@ -14855,7 +14961,7 @@
|
|
14855
14961
|
},
|
14856
14962
|
{
|
14857
14963
|
"disabled": false,
|
14858
|
-
"document": "执行延迟(秒)",
|
14964
|
+
"document": "执行延迟(秒),0~120秒,默认60秒",
|
14859
14965
|
"example": "5",
|
14860
14966
|
"member": "int64",
|
14861
14967
|
"name": "ProcessDelay",
|
@@ -14865,7 +14971,7 @@
|
|
14865
14971
|
},
|
14866
14972
|
{
|
14867
14973
|
"disabled": false,
|
14868
|
-
"document": "源topicId
|
14974
|
+
"document": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。",
|
14869
14975
|
"example": "ap-guangzhou",
|
14870
14976
|
"member": "string",
|
14871
14977
|
"name": "SrcTopicRegion",
|
@@ -15924,7 +16030,7 @@
|
|
15924
16030
|
},
|
15925
16031
|
{
|
15926
16032
|
"disabled": false,
|
15927
|
-
"document": "
|
16033
|
+
"document": "创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
|
15928
16034
|
"example": "2024-11-13 14:48:23",
|
15929
16035
|
"member": "string",
|
15930
16036
|
"name": "CreateTime",
|
@@ -16064,7 +16170,7 @@
|
|
16064
16170
|
},
|
16065
16171
|
{
|
16066
16172
|
"disabled": false,
|
16067
|
-
"document": "
|
16173
|
+
"document": "异步迁移状态\n- 1:进行中\n- 2:已完成\n- 3:失败\n- 4:已取消",
|
16068
16174
|
"example": "1",
|
16069
16175
|
"member": "uint64",
|
16070
16176
|
"name": "MigrationStatus",
|
@@ -16074,7 +16180,7 @@
|
|
16074
16180
|
},
|
16075
16181
|
{
|
16076
16182
|
"disabled": false,
|
16077
|
-
"document": "
|
16183
|
+
"document": "异步迁移完成后,预计生效日期\n时间格式:yyyy-MM-dd HH:mm:ss",
|
16078
16184
|
"example": "2024-11-13 14:48:23",
|
16079
16185
|
"member": "string",
|
16080
16186
|
"name": "EffectiveDate",
|
@@ -16196,7 +16302,7 @@
|
|
16196
16302
|
"members": [
|
16197
16303
|
{
|
16198
16304
|
"disabled": false,
|
16199
|
-
"document": "回调的类型。可选值:\n- Http\n- WeCom\n- DingTalk\n- Lark",
|
16305
|
+
"document": "回调的类型。可选值:\n- Http(自定义接口回调)\n- WeCom(企业微信)\n- DingTalk(钉钉)\n- Lark(飞书)",
|
16200
16306
|
"example": "WeCom",
|
16201
16307
|
"member": "string",
|
16202
16308
|
"name": "CallbackType",
|
@@ -16218,7 +16324,7 @@
|
|
16218
16324
|
},
|
16219
16325
|
{
|
16220
16326
|
"disabled": false,
|
16221
|
-
"document": "集成配置ID
|
16327
|
+
"document": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID",
|
16222
16328
|
"example": "\"webcallback-aaa-bbb-ccc-ddd\"",
|
16223
16329
|
"member": "string",
|
16224
16330
|
"name": "WebCallbackId",
|
@@ -16274,7 +16380,7 @@
|
|
16274
16380
|
{
|
16275
16381
|
"disabled": false,
|
16276
16382
|
"document": "用户ID列表。",
|
16277
|
-
"example": "[\"
|
16383
|
+
"example": "[\"11274\"]",
|
16278
16384
|
"member": "string",
|
16279
16385
|
"name": "UserIds",
|
16280
16386
|
"output_required": false,
|
@@ -16403,7 +16509,7 @@
|
|
16403
16509
|
},
|
16404
16510
|
{
|
16405
16511
|
"disabled": false,
|
16406
|
-
"document": "
|
16512
|
+
"document": "创建时间。秒(s)级时间戳",
|
16407
16513
|
"example": "1693468888",
|
16408
16514
|
"member": "uint64",
|
16409
16515
|
"name": "CreateTime",
|
@@ -16413,7 +16519,7 @@
|
|
16413
16519
|
},
|
16414
16520
|
{
|
16415
16521
|
"disabled": false,
|
16416
|
-
"document": "
|
16522
|
+
"document": "更新时间。秒(s)级时间戳",
|
16417
16523
|
"example": "1693468888",
|
16418
16524
|
"member": "uint64",
|
16419
16525
|
"name": "UpdateTime",
|