tccli 3.0.1371.1__py2.py3-none-any.whl → 3.0.1372.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.
Files changed (49) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/batch/v20170312/api.json +56 -56
  3. tccli/services/batch/v20170312/examples.json +3 -3
  4. tccli/services/cfg/v20210820/api.json +5 -5
  5. tccli/services/cfg/v20210820/examples.json +1 -1
  6. tccli/services/ckafka/v20190819/api.json +21 -21
  7. tccli/services/clb/v20180317/api.json +7 -7
  8. tccli/services/cls/v20201016/api.json +311 -207
  9. tccli/services/cls/v20201016/examples.json +28 -28
  10. tccli/services/csip/v20221121/examples.json +1 -1
  11. tccli/services/ctem/v20231128/api.json +104 -104
  12. tccli/services/ctem/v20231128/examples.json +8 -8
  13. tccli/services/dnspod/v20210323/api.json +14 -4
  14. tccli/services/dnspod/v20210323/examples.json +2 -2
  15. tccli/services/es/v20180416/api.json +23 -4
  16. tccli/services/ess/v20201111/api.json +3 -3
  17. tccli/services/essbasic/v20210526/api.json +4 -4
  18. tccli/services/iai/v20200303/api.json +9 -0
  19. tccli/services/lighthouse/lighthouse_client.py +106 -0
  20. tccli/services/lighthouse/v20200324/api.json +280 -0
  21. tccli/services/lighthouse/v20200324/examples.json +22 -0
  22. tccli/services/live/v20180801/api.json +1 -1
  23. tccli/services/lke/lke_client.py +0 -53
  24. tccli/services/lke/v20231130/api.json +29 -79
  25. tccli/services/lke/v20231130/examples.json +0 -8
  26. tccli/services/monitor/v20180724/api.json +3 -3
  27. tccli/services/ocr/v20181119/api.json +22 -2
  28. tccli/services/organization/v20210331/api.json +25 -25
  29. tccli/services/organization/v20210331/examples.json +1 -1
  30. tccli/services/ssl/v20191205/api.json +1 -1
  31. tccli/services/teo/v20220901/api.json +12 -12
  32. tccli/services/tione/v20211111/api.json +18 -18
  33. tccli/services/tms/v20201229/api.json +6 -6
  34. tccli/services/trtc/trtc_client.py +159 -0
  35. tccli/services/trtc/v20190722/api.json +264 -0
  36. tccli/services/trtc/v20190722/examples.json +24 -0
  37. tccli/services/tse/v20201207/api.json +23 -5
  38. tccli/services/tse/v20201207/examples.json +2 -2
  39. tccli/services/tsf/v20180326/api.json +490 -490
  40. tccli/services/tsf/v20180326/examples.json +21 -21
  41. tccli/services/vod/v20180717/api.json +12 -1
  42. tccli/services/vpc/v20170312/api.json +12 -2
  43. tccli/services/vpc/v20170312/examples.json +2 -2
  44. tccli/services/wsa/v20250508/api.json +21 -3
  45. {tccli-3.0.1371.1.dist-info → tccli-3.0.1372.1.dist-info}/METADATA +2 -2
  46. {tccli-3.0.1371.1.dist-info → tccli-3.0.1372.1.dist-info}/RECORD +49 -49
  47. {tccli-3.0.1371.1.dist-info → tccli-3.0.1372.1.dist-info}/WHEEL +0 -0
  48. {tccli-3.0.1371.1.dist-info → tccli-3.0.1372.1.dist-info}/entry_points.txt +0 -0
  49. {tccli-3.0.1371.1.dist-info → tccli-3.0.1372.1.dist-info}/license_files/LICENSE +0 -0
@@ -120,7 +120,7 @@
120
120
  "status": "online"
121
121
  },
122
122
  "CreateExport": {
123
- "document": "本接口仅创建下载任务,任务返回的下载地址,请用户调用DescribeExports查看任务列表。其中有下载地址CosPath参数。参考文档https://cloud.tencent.com/document/product/614/56449",
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
  },
@@ -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",
@@ -1911,8 +1911,8 @@
1911
1911
  "members": [
1912
1912
  {
1913
1913
  "disabled": false,
1914
- "document": "采集配置ID",
1915
- "example": "xxxxxxxxxx",
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": "xxx-xxx-xxxxxx",
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": "加工任务目的topic_id以及别名",
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": "10.10.2.42",
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": "日志主题ID",
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": "b388dc72-xxxx-xxxx-9dbb-7d05fdff0376",
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-xxx1",
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": "fadcc986-xxxx-xxxx-b766-9ce9c193da32",
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": "类型:container_stdoutcontainer_filehost_file",
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": "default",
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": "b388dc72-xxxx-xxxx-9dbb-7d05fdff0376",
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": "default",
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": [
@@ -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)地域入參格式存在差异, 请参考如下示例:\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",
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": "xxxxxx-xxx-xxxxxx",
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\\\"]},\\\"processors\\\":[{\\\"type\\\":\\\"processor_timeformat\\\",\\\"detail\\\":{\\\"KeepSource\\\":true,\\\"TimeFormat\\\":\\\"%s\\\",\\\"SourceKey\\\":\\\"time\\\"}},{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"KeepSource\\\":false,\\\"Delimiter\\\":\\\"|\\\",\\\"SourceKey\\\":\\\"msg1\\\",\\\"ExtractKeys\\\":[\\\"submsg1\\\",\\\"submsg2\\\",\\\"submsg3\\\"]},\\\"processors\\\":[]},{\\\"type\\\":\\\"processor_split_key_value\\\",\\\"detail\\\":{\\\"KeepSource\\\":false,\\\"Delimiter\\\":\\\":\\\",\\\"SourceKey\\\":\\\"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": "投递任务绑定的日志主题 ID",
4387
- "example": "3c38e5b1-xxxx-xxxx-8963-3af704e22e73",
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": "仪表盘id。",
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表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】",
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": "投递规则属于的 topic id",
4740
- "example": "xxx-xxx-xxx-xxx",
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": "test-report-es",
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": "default",
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": "$DEFAULT",
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": "10000000",
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": "日志主题ID",
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__\",\"a\",\"b\"]",
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目标topic ID",
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": "cls-dfxxx",
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,
@@ -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": "xxxxxx-xx-xx-xx-xxxxxxxx",
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": "user-define-233435352",
5822
+ "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
5729
5823
  "member": "string",
5730
5824
  "name": "TopicId",
5731
5825
  "required": false,
@@ -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\",\"12345\"]",
6138
+ "example": "[\"168053\",\"1\"]",
6045
6139
  "member": "string",
6046
6140
  "name": "Values",
6047
6141
  "output_required": true,
@@ -6464,8 +6558,8 @@
6464
6558
  "members": [
6465
6559
  {
6466
6560
  "disabled": false,
6467
- "document": "屏蔽规则id",
6468
- "example": "bb42f112-a74d-456e-b3c4-ff5472911b42",
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-456e-b3c4-ff5472911b42",
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)地域入參格式存在差异, 请参考如下示例:\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",
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": "xxx-xxx-xxxxxx",
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": "xxxxxxxxxx",
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": "采集规则配置ID",
6631
- "example": "xxxxxxxxxx",
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": "投递任务绑定的日志主题 ID",
6685
- "example": "\"xxx-xxx-xxx-xxx\"",
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": "数据加工任务id",
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": "日志导出ID",
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": "机器组ID",
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": "机器组ID",
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",
@@ -7005,8 +7099,8 @@
7005
7099
  "members": [
7006
7100
  {
7007
7101
  "disabled": false,
7008
- "document": "任务ID",
7009
- "example": "6ef60bec-0242-43af-bb20-270359fb5xxx",
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",
@@ -7511,7 +7605,7 @@
7511
7605
  "members": [
7512
7606
  {
7513
7607
  "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。",
7608
+ "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
7609
  "example": "无",
7516
7610
  "member": "Filter",
7517
7611
  "name": "Filters",
@@ -7576,8 +7670,8 @@
7576
7670
  "members": [
7577
7671
  {
7578
7672
  "disabled": false,
7579
- "document": "采集配置ID",
7580
- "example": "xxxxxxxxxx",
7673
+ "document": "采集配置ID\n- 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。",
7674
+ "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
7581
7675
  "member": "string",
7582
7676
  "name": "ConfigId",
7583
7677
  "required": true,
@@ -7613,7 +7707,7 @@
7613
7707
  "members": [
7614
7708
  {
7615
7709
  "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。",
7710
+ "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
7711
  "example": "无",
7618
7712
  "member": "Filter",
7619
7713
  "name": "Filters",
@@ -7691,6 +7785,16 @@
7691
7785
  "type": "int",
7692
7786
  "value_allowed_null": false
7693
7787
  },
7788
+ {
7789
+ "disabled": false,
7790
+ "document": "控制台免密分享列表",
7791
+ "example": "无",
7792
+ "member": "ConsoleSharingInfo",
7793
+ "name": "ConsoleSharingInfos",
7794
+ "output_required": true,
7795
+ "type": "list",
7796
+ "value_allowed_null": false
7797
+ },
7694
7798
  {
7695
7799
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
7696
7800
  "member": "string",
@@ -7705,8 +7809,8 @@
7705
7809
  "members": [
7706
7810
  {
7707
7811
  "disabled": false,
7708
- "document": "投递任务绑定的日志主题 ID",
7709
- "example": "\"xxx-xxx-xxx-xxx\"",
7812
+ "document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
7813
+ "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
7710
7814
  "member": "string",
7711
7815
  "name": "TopicId",
7712
7816
  "required": true,
@@ -8039,7 +8143,7 @@
8039
8143
  "members": [
8040
8144
  {
8041
8145
  "disabled": false,
8042
- "document": "日志主题ID",
8146
+ "document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
8043
8147
  "example": "ee20bb16-3025-4048-b81a-dd436373062e",
8044
8148
  "member": "string",
8045
8149
  "name": "TopicId",
@@ -8073,10 +8177,10 @@
8073
8177
  {
8074
8178
  "disabled": false,
8075
8179
  "document": "日志导出列表",
8076
- "example": "[]",
8180
+ "example": "",
8077
8181
  "member": "ExportInfo",
8078
8182
  "name": "Exports",
8079
- "required": true,
8183
+ "output_required": true,
8080
8184
  "type": "list",
8081
8185
  "value_allowed_null": false
8082
8186
  },
@@ -8086,7 +8190,7 @@
8086
8190
  "example": "1",
8087
8191
  "member": "int64",
8088
8192
  "name": "TotalCount",
8089
- "required": true,
8193
+ "output_required": true,
8090
8194
  "type": "int",
8091
8195
  "value_allowed_null": false
8092
8196
  },
@@ -8191,7 +8295,7 @@
8191
8295
  "members": [
8192
8296
  {
8193
8297
  "disabled": false,
8194
- "document": "日志主题ID",
8298
+ "document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
8195
8299
  "example": "57f5808c-4a55-11eb-b378-0242ac130002",
8196
8300
  "member": "string",
8197
8301
  "name": "FromTopicId",
@@ -8258,7 +8362,7 @@
8258
8362
  "members": [
8259
8363
  {
8260
8364
  "disabled": false,
8261
- "document": "日志主题 ID",
8365
+ "document": "日志主题Id。\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
8262
8366
  "example": "6bf3355c-xxxx-xxxx-89c8-76c3ca37bae9",
8263
8367
  "member": "string",
8264
8368
  "name": "TopicId",
@@ -8267,7 +8371,7 @@
8267
8371
  },
8268
8372
  {
8269
8373
  "disabled": false,
8270
- "document": "导入配置ID",
8374
+ "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
8375
  "example": "f574db7d-45ff-xxxx-xxxx-35f7fe71a4d0",
8272
8376
  "member": "string",
8273
8377
  "name": "Id",
@@ -8276,7 +8380,7 @@
8276
8380
  },
8277
8381
  {
8278
8382
  "disabled": false,
8279
- "document": "状态 status 1: 运行中, 2: 暂停...",
8383
+ "document": "状态。1: 运行中,2: 暂停,3:错误",
8280
8384
  "example": "1",
8281
8385
  "member": "uint64",
8282
8386
  "name": "Status",
@@ -8470,7 +8574,7 @@
8470
8574
  },
8471
8575
  {
8472
8576
  "disabled": false,
8473
- "document": "查询语句",
8577
+ "document": "检索分析语句。\n语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。\n使用*或空字符串可查询所有日志。",
8474
8578
  "example": "http_status:200",
8475
8579
  "member": "string",
8476
8580
  "name": "Query",
@@ -8479,7 +8583,7 @@
8479
8583
  },
8480
8584
  {
8481
8585
  "disabled": false,
8482
- "document": "要查询的日志主题ID",
8586
+ "document": "要查询的日志主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
8483
8587
  "example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
8484
8588
  "member": "string",
8485
8589
  "name": "TopicId",
@@ -8619,8 +8723,8 @@
8619
8723
  "members": [
8620
8724
  {
8621
8725
  "disabled": false,
8622
- "document": "机器组ID",
8623
- "example": "xxxxx-xxx-xxxxx",
8726
+ "document": "机器组ID\n- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。",
8727
+ "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a",
8624
8728
  "member": "string",
8625
8729
  "name": "GroupId",
8626
8730
  "required": true,
@@ -8656,7 +8760,7 @@
8656
8760
  "members": [
8657
8761
  {
8658
8762
  "disabled": false,
8659
- "document": "machineGroupName\n- 按照【机器组名称】进行过滤。\n- 类型:String\n- 必选:否\n\nmachineGroupId\n- 按照【机器组ID】进行过滤。\n- 类型:String\n- 必选:否\n\nosType\n- 按照【操作系统类型】进行过滤。\n- 类型:Int\n- 必选:否\n\ntagKey\n- 按照【标签键】进行过滤。\n- 类型:String\n- 必选:否\n\ntag:tagKey\n- 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。\n- 类型:String\n- 必选:否\n\n每次请求的Filters的上限为10,Filter.Values的上限为5。",
8763
+ "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
8764
  "example": "无",
8661
8765
  "member": "Filter",
8662
8766
  "name": "Filters",
@@ -8910,8 +9014,8 @@
8910
9014
  "members": [
8911
9015
  {
8912
9016
  "disabled": false,
8913
- "document": "日志主题ID",
8914
- "example": "cabcd0a8-4a54-11eb-b378-0242ac130002",
9017
+ "document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
9018
+ "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
8915
9019
  "member": "string",
8916
9020
  "name": "TopicId",
8917
9021
  "required": true,
@@ -8975,7 +9079,7 @@
8975
9079
  {
8976
9080
  "disabled": false,
8977
9081
  "document": "任务id。",
8978
- "example": "6ef60bec-xxxx-xxxx-bb20-270359fb54xx",
9082
+ "example": "9c64f9c1-a14e-4b59-b074-5b73cac3dd66",
8979
9083
  "member": "string",
8980
9084
  "name": "TaskId",
8981
9085
  "required": false,
@@ -8983,7 +9087,7 @@
8983
9087
  },
8984
9088
  {
8985
9089
  "disabled": false,
8986
- "document": "<li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>\n<li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>\n<li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>\n<li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>\n<li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>\n<li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>\n<li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>\n<li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>\n",
9090
+ "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
9091
  "example": "无",
8988
9092
  "member": "Filter",
8989
9093
  "name": "Filters",
@@ -9159,7 +9263,7 @@
9159
9263
  "members": [
9160
9264
  {
9161
9265
  "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 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型: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。",
9266
+ "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
9267
  "example": "无",
9164
9268
  "member": "Filter",
9165
9269
  "name": "Filters",
@@ -9407,7 +9511,7 @@
9407
9511
  },
9408
9512
  {
9409
9513
  "disabled": false,
9410
- "document": "时间类型,1:用户自定义,2:当前时间",
9514
+ "document": "时间字段(Timestamp)支持的类型\n- 1(用户自定义时间)\n- 2(当前时间)",
9411
9515
  "example": "1",
9412
9516
  "member": "uint64",
9413
9517
  "name": "TimeType",
@@ -9418,8 +9522,8 @@
9418
9522
  },
9419
9523
  {
9420
9524
  "disabled": false,
9421
- "document": "时间,用户选择自定义时间类型时,需要指定时间,单位秒",
9422
- "example": "12345675",
9525
+ "document": "时间,用户选择自定义时间类型时,需要指定时间,单位秒\n格式:时间戳,1754897446",
9526
+ "example": "1754897446",
9423
9527
  "member": "uint64",
9424
9528
  "name": "Timestamp",
9425
9529
  "output_required": true,
@@ -9564,7 +9668,7 @@
9564
9668
  },
9565
9669
  {
9566
9670
  "disabled": false,
9567
- "document": "日志导出起始时间",
9671
+ "document": "日志导出起始时间,毫秒时间戳",
9568
9672
  "example": "1607499207000",
9569
9673
  "member": "int64",
9570
9674
  "name": "From",
@@ -9574,7 +9678,7 @@
9574
9678
  },
9575
9679
  {
9576
9680
  "disabled": false,
9577
- "document": "日志导出结束时间",
9681
+ "document": "日志导出结束时间,毫秒时间戳",
9578
9682
  "example": "1607499208000",
9579
9683
  "member": "int64",
9580
9684
  "name": "To",
@@ -9594,7 +9698,7 @@
9594
9698
  },
9595
9699
  {
9596
9700
  "disabled": false,
9597
- "document": "日志导出创建时间",
9701
+ "document": "日志导出创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
9598
9702
  "example": "2020-08-08 12:12:12",
9599
9703
  "member": "string",
9600
9704
  "name": "CreateTime",
@@ -9615,7 +9719,7 @@
9615
9719
  {
9616
9720
  "disabled": false,
9617
9721
  "document": "导出字段",
9618
- "example": "[\"__timestamp__\",\"a\",\"b\"]",
9722
+ "example": "[\"__timestamp__\"]",
9619
9723
  "member": "string",
9620
9724
  "name": "DerivedFields",
9621
9725
  "output_required": false,
@@ -9630,7 +9734,7 @@
9630
9734
  "members": [
9631
9735
  {
9632
9736
  "disabled": false,
9633
- "document": "时间字段的key名字,TikeKey和TimeFormat必须成对出现",
9737
+ "document": "时间字段的key名字,TimeKey和TimeFormat必须成对出现",
9634
9738
  "example": "time",
9635
9739
  "member": "string",
9636
9740
  "name": "TimeKey",
@@ -9641,8 +9745,8 @@
9641
9745
  },
9642
9746
  {
9643
9747
  "disabled": false,
9644
- "document": "时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数",
9645
- "example": "YYDDWW",
9748
+ "document": "时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数\n- 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档 ",
9749
+ "example": "%Y-%m-%d %H:%M:%S",
9646
9750
  "member": "string",
9647
9751
  "name": "TimeFormat",
9648
9752
  "output_required": true,
@@ -9730,7 +9834,7 @@
9730
9834
  {
9731
9835
  "disabled": false,
9732
9836
  "document": "增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。\n注意:\n- COS导入不支持此字段。\n注意:此字段可能返回 null,表示取不到有效值。",
9733
- "example": "-1",
9837
+ "example": "0",
9734
9838
  "member": "int64",
9735
9839
  "name": "Backtracking",
9736
9840
  "output_required": true,
@@ -9999,7 +10103,7 @@
9999
10103
  },
10000
10104
  {
10001
10105
  "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`",
10106
+ "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
10107
  "example": "alert_id:notice-c0960eb3-6454-4eef-xxxx-8feb766a9fbd",
10004
10108
  "member": "string",
10005
10109
  "name": "Query",
@@ -10071,7 +10175,7 @@
10071
10175
  {
10072
10176
  "disabled": false,
10073
10177
  "document": "返回的结果是否为SQL分析结果",
10074
- "example": "1",
10178
+ "example": "true",
10075
10179
  "member": "bool",
10076
10180
  "name": "Analysis",
10077
10181
  "output_required": true,
@@ -10111,7 +10215,7 @@
10111
10215
  {
10112
10216
  "disabled": false,
10113
10217
  "document": "执行详情统计分析结果;UseNewAnalysis为true有效。\n注意:此字段可能返回 null,表示取不到有效值。",
10114
- "example": "[\"xxx\",\"yy\"]",
10218
+ "example": "[\"acd\",\"ac\"]",
10115
10219
  "member": "string",
10116
10220
  "name": "AnalysisRecords",
10117
10221
  "output_required": true,
@@ -10200,17 +10304,17 @@
10200
10304
  "example": "15",
10201
10305
  "member": "int64",
10202
10306
  "name": "Count",
10203
- "required": true,
10307
+ "output_required": true,
10204
10308
  "type": "int",
10205
10309
  "value_allowed_null": false
10206
10310
  },
10207
10311
  {
10208
10312
  "disabled": false,
10209
10313
  "document": "按 period 取整后的 unix timestamp: 单位毫秒",
10210
- "example": "2021-04-25 14:25:00.000",
10314
+ "example": "1754856576000",
10211
10315
  "member": "int64",
10212
10316
  "name": "BTime",
10213
- "required": true,
10317
+ "output_required": true,
10214
10318
  "type": "int",
10215
10319
  "value_allowed_null": false
10216
10320
  }
@@ -10361,7 +10465,7 @@
10361
10465
  "members": [
10362
10466
  {
10363
10467
  "disabled": false,
10364
- "document": "协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。\n入参必填",
10468
+ "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
10469
  "example": "sasl_ssl",
10366
10470
  "member": "string",
10367
10471
  "name": "Protocol",
@@ -10372,7 +10476,7 @@
10372
10476
  },
10373
10477
  {
10374
10478
  "disabled": false,
10375
- "document": "加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。\n当Protocol为sasl_plaintext或sasl_ssl时必填",
10479
+ "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
10480
  "example": "PLAIN",
10377
10481
  "member": "string",
10378
10482
  "name": "Mechanism",
@@ -10919,7 +11023,7 @@
10919
11023
  },
10920
11024
  {
10921
11025
  "disabled": false,
10922
- "document": "使用默认时间,true:开启(默认值), flase:关闭",
11026
+ "document": "使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true",
10923
11027
  "example": "true",
10924
11028
  "member": "bool",
10925
11029
  "name": "DefaultTimeSwitch",
@@ -10985,7 +11089,7 @@
10985
11089
  },
10986
11090
  {
10987
11091
  "disabled": false,
10988
- "document": "时间字段",
11092
+ "document": "时间字段,日志中代表时间的字段名。\n\n- 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。",
10989
11093
  "example": "__TIMESTAMP__",
10990
11094
  "member": "string",
10991
11095
  "name": "TimeKey",
@@ -10996,7 +11100,7 @@
10996
11100
  },
10997
11101
  {
10998
11102
  "disabled": false,
10999
- "document": "时间提取正则表达式",
11103
+ "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
11104
  "example": "(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})",
11001
11105
  "member": "string",
11002
11106
  "name": "TimeRegex",
@@ -11007,7 +11111,7 @@
11007
11111
  },
11008
11112
  {
11009
11113
  "disabled": false,
11010
- "document": "时间字段格式",
11114
+ "document": "时间字段格式。\n- 当DefaultTimeSwitch为false时, TimeFormat不能为空。",
11011
11115
  "example": "%Y-%m-%d %H:%M:%S",
11012
11116
  "member": "string",
11013
11117
  "name": "TimeFormat",
@@ -11018,7 +11122,7 @@
11018
11122
  },
11019
11123
  {
11020
11124
  "disabled": false,
11021
- "document": "时间字段时区",
11125
+ "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
11126
  "example": "UTC+08:00",
11023
11127
  "member": "string",
11024
11128
  "name": "TimeZone",
@@ -11174,7 +11278,7 @@
11174
11278
  },
11175
11279
  {
11176
11280
  "disabled": false,
11177
- "document": "创建时间",
11281
+ "document": "创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
11178
11282
  "example": "2021-03-05 00:40:22",
11179
11283
  "member": "string",
11180
11284
  "name": "CreateTime",
@@ -11204,7 +11308,7 @@
11204
11308
  },
11205
11309
  {
11206
11310
  "disabled": false,
11207
- "document": "升级开始时间,建议业务低峰期升级LogListener",
11311
+ "document": "升级开始时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
11208
11312
  "example": "\"12:00:00\"",
11209
11313
  "member": "string",
11210
11314
  "name": "UpdateStartTime",
@@ -11214,7 +11318,7 @@
11214
11318
  },
11215
11319
  {
11216
11320
  "disabled": false,
11217
- "document": "升级结束时间,建议业务低峰期升级LogListener",
11321
+ "document": "升级结束时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
11218
11322
  "example": "\"13:00:00\"",
11219
11323
  "member": "string",
11220
11324
  "name": "UpdateEndTime",
@@ -11234,7 +11338,7 @@
11234
11338
  },
11235
11339
  {
11236
11340
  "disabled": false,
11237
- "document": "机器组中机器离线定期清理时间",
11341
+ "document": "机器组中机器离线定期清理时间,单位天,默认设置30天。",
11238
11342
  "example": "30",
11239
11343
  "member": "int64",
11240
11344
  "name": "DelayCleanupTime",
@@ -11394,7 +11498,7 @@
11394
11498
  "members": [
11395
11499
  {
11396
11500
  "disabled": false,
11397
- "document": "日志主题ID",
11501
+ "document": "日志主题Id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
11398
11502
  "example": "427bba81-e149-4a8b-bd0d-b2a412520d7b",
11399
11503
  "member": "string",
11400
11504
  "name": "TopicId",
@@ -11403,7 +11507,7 @@
11403
11507
  },
11404
11508
  {
11405
11509
  "disabled": false,
11406
- "document": "合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)\n\n1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);\n2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);\n3. topic的分区数量是有限制的(默认50个),合并之后不能超过最大分区,否则不能合并。",
11510
+ "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
11511
  "example": "2",
11408
11512
  "member": "int64",
11409
11513
  "name": "PartitionId",
@@ -12153,7 +12257,7 @@
12153
12257
  },
12154
12258
  {
12155
12259
  "disabled": false,
12156
- "document": "采集规则配置名称",
12260
+ "document": "采集规则配置名称\n- 不能包含特殊字符|\n- 长度不能超过255字符,超过会被截断",
12157
12261
  "example": "testname",
12158
12262
  "member": "string",
12159
12263
  "name": "Name",
@@ -12198,7 +12302,7 @@
12198
12302
  },
12199
12303
  {
12200
12304
  "disabled": false,
12201
- "document": "采集配置关联的日志主题(TopicId",
12305
+ "document": "采集配置关联的日志主题(TopicId)\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
12202
12306
  "example": "57f5808c-4a55-11eb-b378-0242ac130002",
12203
12307
  "member": "string",
12204
12308
  "name": "Output",
@@ -12208,7 +12312,7 @@
12208
12312
  {
12209
12313
  "disabled": false,
12210
12314
  "document": "用户自定义解析字符串,Json格式序列化的字符串。",
12211
- "example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]},\\\"processors\\\":[{\\\"type\\\":\\\"processor_timeformat\\\",\\\"detail\\\":{\\\"KeepSource\\\":true,\\\"TimeFormat\\\":\\\"%s\\\",\\\"SourceKey\\\":\\\"time\\\"}},{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"KeepSource\\\":false,\\\"Delimiter\\\":\\\"|\\\",\\\"SourceKey\\\":\\\"msg1\\\",\\\"ExtractKeys\\\":[\\\"submsg1\\\",\\\"submsg2\\\",\\\"submsg3\\\"]},\\\"processors\\\":[]},{\\\"type\\\":\\\"processor_split_key_value\\\",\\\"detail\\\":{\\\"KeepSource\\\":false,\\\"Delimiter\\\":\\\":\\\",\\\"SourceKey\\\":\\\"msg2\\\"}}]}]}\"",
12315
+ "example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}]}\"",
12212
12316
  "member": "string",
12213
12317
  "name": "UserDefineRule",
12214
12318
  "required": false,
@@ -12243,7 +12347,7 @@
12243
12347
  "members": [
12244
12348
  {
12245
12349
  "disabled": false,
12246
- "document": "免密分享链接Id",
12350
+ "document": "免密分享Id。\n- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 \n- 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。",
12247
12351
  "example": "13cez28h",
12248
12352
  "member": "string",
12249
12353
  "name": "SharingId",
@@ -12279,8 +12383,8 @@
12279
12383
  "members": [
12280
12384
  {
12281
12385
  "disabled": false,
12282
- "document": "投递任务绑定的日志主题 ID",
12283
- "example": "\"xxx-xxx-xxx-xxx\"",
12386
+ "document": "投递任务绑定的日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
12387
+ "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612",
12284
12388
  "member": "string",
12285
12389
  "name": "TopicId",
12286
12390
  "required": true,
@@ -12675,7 +12779,7 @@
12675
12779
  "members": [
12676
12780
  {
12677
12781
  "disabled": false,
12678
- "document": "日志主题ID",
12782
+ "document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
12679
12783
  "example": "57f5808c-4a55-11eb-b378-0242ac130002",
12680
12784
  "member": "string",
12681
12785
  "name": "FromTopicId",
@@ -12684,7 +12788,7 @@
12684
12788
  },
12685
12789
  {
12686
12790
  "disabled": false,
12687
- "document": "压缩方式[0:NONE;2:SNAPPY;3:LZ4]",
12791
+ "document": "压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩",
12688
12792
  "example": "2",
12689
12793
  "member": "int64",
12690
12794
  "name": "Compression",
@@ -12720,7 +12824,7 @@
12720
12824
  "members": [
12721
12825
  {
12722
12826
  "disabled": false,
12723
- "document": "Kafka导入配置ID",
12827
+ "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
12828
  "example": "1014cc79-f006-48e4-8820-1dc7270540c0",
12725
12829
  "member": "string",
12726
12830
  "name": "Id",
@@ -12729,7 +12833,7 @@
12729
12833
  },
12730
12834
  {
12731
12835
  "disabled": false,
12732
- "document": "导入CLS目标topic ID",
12836
+ "document": "导入CLS目标TopicId。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。",
12733
12837
  "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111",
12734
12838
  "member": "string",
12735
12839
  "name": "TopicId",
@@ -12756,7 +12860,7 @@
12756
12860
  },
12757
12861
  {
12758
12862
  "disabled": false,
12759
- "document": "腾讯云CKafka实例ID,KafkaType为0时必填。",
12863
+ "document": "腾讯云CKafka实例ID,KafkaType为0时必填。\n- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。",
12760
12864
  "example": "ckafka-2vrgxbxa",
12761
12865
  "member": "string",
12762
12866
  "name": "KafkaInstance",
@@ -12792,7 +12896,7 @@
12792
12896
  },
12793
12897
  {
12794
12898
  "disabled": false,
12795
- "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开",
12899
+ "document": "用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。\n\n- Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。",
12796
12900
  "example": "topic-subs-0px4qkvu32-cdb-5zi7jf11",
12797
12901
  "member": "string",
12798
12902
  "name": "UserKafkaTopics",
@@ -12819,7 +12923,7 @@
12819
12923
  },
12820
12924
  {
12821
12925
  "disabled": false,
12822
- "document": "导入控制,1:暂停;2:继续。",
12926
+ "document": "导入控制,1:暂停;2:启动。",
12823
12927
  "example": "1",
12824
12928
  "member": "uint64",
12825
12929
  "name": "StatusControl",
@@ -12891,7 +12995,7 @@
12891
12995
  "members": [
12892
12996
  {
12893
12997
  "disabled": false,
12894
- "document": "机器组ID",
12998
+ "document": "机器组Id\n- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。",
12895
12999
  "example": "57f5808c-4a55-11eb-b378-0242ac130002",
12896
13000
  "member": "string",
12897
13001
  "name": "GroupId",
@@ -12900,7 +13004,7 @@
12900
13004
  },
12901
13005
  {
12902
13006
  "disabled": false,
12903
- "document": "机器组名称",
13007
+ "document": "机器组名称\n输入限制:\n- 不能为空字符串\n- 不能包含字符'|'",
12904
13008
  "example": "testname",
12905
13009
  "member": "string",
12906
13010
  "name": "GroupName",
@@ -12936,7 +13040,7 @@
12936
13040
  },
12937
13041
  {
12938
13042
  "disabled": false,
12939
- "document": "升级开始时间,建议业务低峰期升级LogListener",
13043
+ "document": "升级开始时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
12940
13044
  "example": "\"12:00:00\"",
12941
13045
  "member": "string",
12942
13046
  "name": "UpdateStartTime",
@@ -12945,7 +13049,7 @@
12945
13049
  },
12946
13050
  {
12947
13051
  "disabled": false,
12948
- "document": "升级结束时间,建议业务低峰期升级LogListener",
13052
+ "document": "升级结束时间,建议业务低峰期升级LogListener\n时间格式:HH:mm:ss",
12949
13053
  "example": "\"13:00:00\"",
12950
13054
  "member": "string",
12951
13055
  "name": "UpdateEndTime",
@@ -13053,7 +13157,7 @@
13053
13157
  "members": [
13054
13158
  {
13055
13159
  "disabled": false,
13056
- "document": "任务ID",
13160
+ "document": "任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
13057
13161
  "example": "6ef60bec-0242-43af-bb20-270359fxxxx",
13058
13162
  "member": "string",
13059
13163
  "name": "TaskId",
@@ -13062,7 +13166,7 @@
13062
13166
  },
13063
13167
  {
13064
13168
  "disabled": false,
13065
- "document": "源日志主题",
13169
+ "document": "源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取",
13066
13170
  "example": "xxxx-0889-4ec0-accc-xxxxxxx",
13067
13171
  "member": "string",
13068
13172
  "name": "SrcTopicId",
@@ -13098,7 +13202,7 @@
13098
13202
  },
13099
13203
  {
13100
13204
  "disabled": false,
13101
- "document": "调度周期(分钟)",
13205
+ "document": "调度周期(分钟),1~1440分钟",
13102
13206
  "example": "2",
13103
13207
  "member": "int64",
13104
13208
  "name": "ProcessPeriod",
@@ -13116,7 +13220,7 @@
13116
13220
  },
13117
13221
  {
13118
13222
  "disabled": false,
13119
- "document": "执行延迟(秒)",
13223
+ "document": "执行延迟(秒),0~120秒,默认60秒",
13120
13224
  "example": "60",
13121
13225
  "member": "int64",
13122
13226
  "name": "ProcessDelay",
@@ -13125,7 +13229,7 @@
13125
13229
  },
13126
13230
  {
13127
13231
  "disabled": false,
13128
- "document": "源topicId的地域信息",
13232
+ "document": "源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)",
13129
13233
  "example": "ap-guangzhou",
13130
13234
  "member": "string",
13131
13235
  "name": "SrcTopicRegion",
@@ -13134,7 +13238,7 @@
13134
13238
  },
13135
13239
  {
13136
13240
  "disabled": false,
13137
- "document": "任务名称",
13241
+ "document": "任务名称,0~255字符",
13138
13242
  "example": "scheduler_sql任务1",
13139
13243
  "member": "string",
13140
13244
  "name": "Name",
@@ -13305,8 +13409,8 @@
13305
13409
  "members": [
13306
13410
  {
13307
13411
  "disabled": false,
13308
- "document": "日志主题ID",
13309
- "example": "xxxxxx-xx-xx-xx-xxxxxxxx",
13412
+ "document": "日志主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
13413
+ "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e",
13310
13414
  "member": "string",
13311
13415
  "name": "TopicId",
13312
13416
  "required": true,
@@ -13314,7 +13418,7 @@
13314
13418
  },
13315
13419
  {
13316
13420
  "disabled": false,
13317
- "document": "日志主题名称",
13421
+ "document": "日志主题名称\n输入限制:\n- 不能为空字符串\n- 不能包含字符'|'\n- 不能使用以下名称[\"cls_service_log\",\"loglistener_status\",\"loglistener_alarm\",\"loglistener_business\",\"cls_service_metric\"]",
13318
13422
  "example": "testname",
13319
13423
  "member": "string",
13320
13424
  "name": "TopicName",
@@ -13350,7 +13454,7 @@
13350
13454
  },
13351
13455
  {
13352
13456
  "disabled": false,
13353
- "document": "若开启最大分裂,该主题能够能够允许的最大分区数",
13457
+ "document": "若开启最大分裂,该主题能够能够允许的最大分区数;\n默认为50;必须为正数",
13354
13458
  "example": "50",
13355
13459
  "member": "int64",
13356
13460
  "name": "MaxSplitPartitions",
@@ -13404,7 +13508,7 @@
13404
13508
  },
13405
13509
  {
13406
13510
  "disabled": false,
13407
- "document": "日志主题分区数量",
13511
+ "document": "日志主题分区数量。\n默认为1;\n取值范围及约束:\n- 当输入值<=0,系统自动调整为1。\n- 如果未传MaxSplitPartitions,需要PartitionCount<=50;\n- 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;",
13408
13512
  "example": "10",
13409
13513
  "member": "uint64",
13410
13514
  "name": "PartitionCount",
@@ -13413,7 +13517,7 @@
13413
13517
  },
13414
13518
  {
13415
13519
  "disabled": false,
13416
- "document": "取消切换存储任务的id",
13520
+ "document": "取消切换存储任务的id\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。",
13417
13521
  "example": "87b94286-1b33-44df-8568-924eb250ef4e",
13418
13522
  "member": "string",
13419
13523
  "name": "CancelTopicAsyncTaskID",
@@ -13644,7 +13748,7 @@
13644
13748
  "members": [
13645
13749
  {
13646
13750
  "disabled": false,
13647
- "document": "通知内容模板标题信息。\n部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。",
13751
+ "document": "通知内容模板标题信息。\n部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。",
13648
13752
  "example": "这是标题。",
13649
13753
  "member": "string",
13650
13754
  "name": "Title",
@@ -13945,7 +14049,7 @@
13945
14049
  "members": [
13946
14050
  {
13947
14051
  "disabled": false,
13948
- "document": "日志主题ID",
14052
+ "document": "日志主题Id。\n- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。\n- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。",
13949
14053
  "example": "57f5808c-4a55-11eb-b378-0242ac130002",
13950
14054
  "member": "string",
13951
14055
  "name": "FromTopicId",
@@ -14076,7 +14180,7 @@
14076
14180
  {
14077
14181
  "disabled": false,
14078
14182
  "document": "分区哈希键起始key",
14079
- "example": "00000000000000000000000000000000",
14183
+ "example": "000000000000000000000000000000f",
14080
14184
  "member": "string",
14081
14185
  "name": "InclusiveBeginKey",
14082
14186
  "output_required": true,
@@ -14086,7 +14190,7 @@
14086
14190
  {
14087
14191
  "disabled": false,
14088
14192
  "document": "分区哈希键结束key",
14089
- "example": "ffffffffffffffffffffffffffffffff",
14193
+ "example": "0fffffffffffffffffffffffffffffff",
14090
14194
  "member": "string",
14091
14195
  "name": "ExclusiveEndKey",
14092
14196
  "output_required": true,
@@ -14095,7 +14199,7 @@
14095
14199
  },
14096
14200
  {
14097
14201
  "disabled": false,
14098
- "document": "分区创建时间",
14202
+ "document": "分区创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
14099
14203
  "example": "2024-10-04 07:43:08",
14100
14204
  "member": "string",
14101
14205
  "name": "CreateTime",
@@ -14105,7 +14209,7 @@
14105
14209
  },
14106
14210
  {
14107
14211
  "disabled": false,
14108
- "document": "只读分区数据停止写入时间\n注意:此字段可能返回 null,表示取不到有效值。",
14212
+ "document": "只读分区数据停止写入时间\n时间格式:yyyy-MM-dd HH:mm:ss\n注意:此字段可能返回 null,表示取不到有效值。",
14109
14213
  "example": "2024-10-06 16:08:59",
14110
14214
  "member": "string",
14111
14215
  "name": "LastWriteTime",
@@ -14321,7 +14425,7 @@
14321
14425
  "members": [
14322
14426
  {
14323
14427
  "disabled": false,
14324
- "document": "查询语句,使用PromQL语法\t",
14428
+ "document": "查询语句,使用PromQL语法\t\n- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档",
14325
14429
  "example": "access_evaluation_duration_bucket",
14326
14430
  "member": "string",
14327
14431
  "name": "Query",
@@ -14330,7 +14434,7 @@
14330
14434
  },
14331
14435
  {
14332
14436
  "disabled": false,
14333
- "document": "指标主题ID",
14437
+ "document": "指标主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
14334
14438
  "example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f",
14335
14439
  "member": "string",
14336
14440
  "name": "TopicId",
@@ -14354,7 +14458,7 @@
14354
14458
  "members": [
14355
14459
  {
14356
14460
  "disabled": false,
14357
- "document": "指标查询结果类型",
14461
+ "document": "指标查询结果类型,支持\n- scalar 标量值\n- string 字符串值\n- vector 瞬时向量\n- matrix 区间向量",
14358
14462
  "example": "vector",
14359
14463
  "member": "string",
14360
14464
  "name": "ResultType",
@@ -14386,7 +14490,7 @@
14386
14490
  "members": [
14387
14491
  {
14388
14492
  "disabled": false,
14389
- "document": "指标主题ID",
14493
+ "document": "指标主题ID\n- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。",
14390
14494
  "example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f",
14391
14495
  "member": "string",
14392
14496
  "name": "TopicId",
@@ -14395,7 +14499,7 @@
14395
14499
  },
14396
14500
  {
14397
14501
  "disabled": false,
14398
- "document": "查询语句,使用PromQL语法",
14502
+ "document": "查询语句,使用PromQL语法\n- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档",
14399
14503
  "example": "access_evaluation_duration_bucket",
14400
14504
  "member": "string",
14401
14505
  "name": "Query",
@@ -14437,7 +14541,7 @@
14437
14541
  "members": [
14438
14542
  {
14439
14543
  "disabled": false,
14440
- "document": "指标查询结果类型",
14544
+ "document": "指标查询结果类型,支持\n- scalar 标量值\n- string 字符串值\n- vector 瞬时向量\n- matrix 区间向量",
14441
14545
  "example": "matrix",
14442
14546
  "member": "string",
14443
14547
  "name": "ResultType",
@@ -14611,7 +14715,7 @@
14611
14715
  "members": [
14612
14716
  {
14613
14717
  "disabled": false,
14614
- "document": "目标主题id",
14718
+ "document": "通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。",
14615
14719
  "example": "xxxxxxxx-0889-4ec0-accc-xxxxxxx",
14616
14720
  "member": "string",
14617
14721
  "name": "TopicId",
@@ -14622,7 +14726,7 @@
14622
14726
  },
14623
14727
  {
14624
14728
  "disabled": false,
14625
- "document": "主题的地域信息",
14729
+ "document": "主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。",
14626
14730
  "example": "ap-guangzhou",
14627
14731
  "member": "string",
14628
14732
  "name": "Region",
@@ -14689,7 +14793,7 @@
14689
14793
  {
14690
14794
  "disabled": false,
14691
14795
  "document": "除了MetricLabels,您还可以使用该参数,为指标补充静态的维度。\n维度名以字母或下划线开头,后面可以跟字母、数字或下划线,长度小于等于1024 字节",
14692
- "example": "[{\"Key\":\"region\",\"Value\":\"gz\"},{\"Key\":\"service\",\"Value\":\"cgi\"}]",
14796
+ "example": "",
14693
14797
  "member": "MetricLabel",
14694
14798
  "name": "CustomMetricLabels",
14695
14799
  "output_required": false,
@@ -14755,7 +14859,7 @@
14755
14859
  },
14756
14860
  {
14757
14861
  "disabled": false,
14758
- "document": "任务创建时间",
14862
+ "document": "任务创建时间。格式:yyyy-MM-dd HH:mm:ss",
14759
14863
  "example": "2023-07-28 11:36:00",
14760
14864
  "member": "string",
14761
14865
  "name": "CreateTime",
@@ -14765,7 +14869,7 @@
14765
14869
  },
14766
14870
  {
14767
14871
  "disabled": false,
14768
- "document": "任务更新时间",
14872
+ "document": "任务更新时间,格式:yyyy-MM-dd HH:mm:ss",
14769
14873
  "example": "2023-07-28 11:36:00",
14770
14874
  "member": "string",
14771
14875
  "name": "UpdateTime",
@@ -14805,7 +14909,7 @@
14805
14909
  },
14806
14910
  {
14807
14911
  "disabled": false,
14808
- "document": "调度开始时间",
14912
+ "document": "调度开始时间,格式:yyyy-MM-dd HH:mm:ss",
14809
14913
  "example": "2023-07-28 11:36:00",
14810
14914
  "member": "string",
14811
14915
  "name": "ProcessStartTime",
@@ -14825,7 +14929,7 @@
14825
14929
  },
14826
14930
  {
14827
14931
  "disabled": false,
14828
- "document": "调度结束时间,当process_type=2时为必传字段",
14932
+ "document": "调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段",
14829
14933
  "example": "2023-07-28 11:36:00",
14830
14934
  "member": "string",
14831
14935
  "name": "ProcessEndTime",
@@ -14835,7 +14939,7 @@
14835
14939
  },
14836
14940
  {
14837
14941
  "disabled": false,
14838
- "document": "调度周期(分钟)",
14942
+ "document": "调度周期(分钟),1~1440分钟",
14839
14943
  "example": "5",
14840
14944
  "member": "int64",
14841
14945
  "name": "ProcessPeriod",
@@ -14855,7 +14959,7 @@
14855
14959
  },
14856
14960
  {
14857
14961
  "disabled": false,
14858
- "document": "执行延迟(秒)",
14962
+ "document": "执行延迟(秒),0~120秒,默认60秒",
14859
14963
  "example": "5",
14860
14964
  "member": "int64",
14861
14965
  "name": "ProcessDelay",
@@ -14865,7 +14969,7 @@
14865
14969
  },
14866
14970
  {
14867
14971
  "disabled": false,
14868
- "document": "源topicId的地域信息",
14972
+ "document": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。",
14869
14973
  "example": "ap-guangzhou",
14870
14974
  "member": "string",
14871
14975
  "name": "SrcTopicRegion",
@@ -15924,7 +16028,7 @@
15924
16028
  },
15925
16029
  {
15926
16030
  "disabled": false,
15927
- "document": "创建时间",
16031
+ "document": "创建时间\n时间格式:yyyy-MM-dd HH:mm:ss",
15928
16032
  "example": "2024-11-13 14:48:23",
15929
16033
  "member": "string",
15930
16034
  "name": "CreateTime",
@@ -16064,7 +16168,7 @@
16064
16168
  },
16065
16169
  {
16066
16170
  "disabled": false,
16067
- "document": "异步迁移状态",
16171
+ "document": "异步迁移状态\n- 1:进行中\n- 2:已完成\n- 3:失败\n- 4:已取消",
16068
16172
  "example": "1",
16069
16173
  "member": "uint64",
16070
16174
  "name": "MigrationStatus",
@@ -16074,7 +16178,7 @@
16074
16178
  },
16075
16179
  {
16076
16180
  "disabled": false,
16077
- "document": "异步迁移完成后,预计生效日期",
16181
+ "document": "异步迁移完成后,预计生效日期\n时间格式:yyyy-MM-dd HH:mm:ss",
16078
16182
  "example": "2024-11-13 14:48:23",
16079
16183
  "member": "string",
16080
16184
  "name": "EffectiveDate",