History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Alarm configuration for the multidimensional analysis
Used by actions: CreateAlarm, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Keys. The following keys are supported: SyntaxRule: Syntax rule, value supports 0: Lucene syntax; 1: CQL syntax. QueryIndex: Serial number of execution statement. Value supports -1: Custom; 1: Execute Statement 1; 2: Execute Statement 2.CustomQuery: Search statement. Valid and required when QueryIndex is -1, example of value: "* |
| Value | String | Yes | Value. Key corresponds to the following values: SyntaxRule: Syntax rule, value supports 0: Lucene syntax; 1: CQL syntax. QueryIndex: Serial number of execution statement. Value supports -1: Custom; 1: Execute Statement 1; 2: Execute Statement 2.CustomQuery: Search statement. Valid and required when QueryIndex is -1, example of value: "* |
Alarm Classification Information
Used by actions: CreateAlarm, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Classification Key |
| Value | String | Yes | Classification Value |
Alarm policy description
Used by actions: DescribeAlarms.
| Name | Type | Description |
|---|---|---|
| Name | String | Alarm policy name |
| AlarmTargets | Array of AlarmTargetInfo | Monitoring object list |
| MonitorTime | MonitorTime | Monitoring task running time point |
| Condition | String | Single trigger condition. Mutually exclusive with the MultiConditions parameter. |
| TriggerCount | Integer | Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by TriggerCount. Value range: 1–10. |
| AlarmPeriod | Integer | Repeated alarm interval in minutes. Value range: 0–1440. |
| AlarmNoticeIds | Array of String | List of associated alarm notification templates |
| Status | Boolean | Enablement status |
| AlarmId | String | Alarm policy ID |
| CreateTime | String | Creation time |
| UpdateTime | String | Last update time |
| MessageTemplate | String | Custom notification template Note: this field may return null, indicating that no valid values can be obtained. |
| CallBack | CallBackInfo | Custom callback template Note: this field may return null, indicating that no valid values can be obtained. |
| Analysis | Array of AnalysisDimensional | Multi-Dimensional analysis settings Note: this field may return null, indicating that no valid values can be obtained. |
| GroupTriggerStatus | Boolean | Group trigger status. 1: Enabled, 0: Disabled (default) Note: This field may return null, indicating that no valid values can be obtained. |
| GroupTriggerCondition | Array of String | Group Trigger ConditionsNote: This field may return null, indicating that no valid values can be obtained. |
| MonitorObjectType | Integer | Type of the monitored object. 0: common monitoring objects for execution statements; 1: separately selected monitoring objects for each execution statement.Note: This field may return null, indicating that no valid values can be obtained. |
| AlarmLevel | Integer | Alarm severity. 0: warning (Warn); 1: Reminder (Info); 2: urgent (Critical).Note: This field may return null, indicating that no valid values can be obtained. |
| MultiConditions | Array of MultiCondition | Multiple trigger conditions. Exclusive with Condition.Note: This field may return null, indicating that no valid values can be obtained. |
Alarm notification template type
Used by actions: DescribeAlarmNotices.
| Name | Type | Description |
|---|---|---|
| Name | String | Alarm notification template name |
| Type | String | Alarm template type. Optional values: |
| NoticeReceivers | Array of NoticeReceiver | Information of the recipient in alarm notification template Note: this field may return null, indicating that no valid values can be obtained. |
| WebCallbacks | Array of WebCallback | Callback information of alarm notification template Note: this field may return null, indicating that no valid values can be obtained. |
| AlarmNoticeId | String | Alarm notification template ID Note: this field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time Note: this field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | Last update time Note: this field may return null, indicating that no valid values can be obtained. |
| NoticeRules | Array of NoticeRule | Notification rules.Note: This field may return null, indicating that no valid values can be obtained. |
Alarm suppression task configuration
Used by actions: DescribeAlarmShields.
| Name | Type | Description |
|---|---|---|
| AlarmNoticeId | String | Notification Channel Group ID |
| TaskId | String | Shield Rule ID |
| StartTime | Integer | Block start time (second-level timestamp). |
| EndTime | Integer | Block end time (second-level timestamp). |
| Type | Integer | Block type. 1: Block all notifications, 2: Block matching rules notifications according to the Rule parameter. |
| Rule | String | Rule for shielding, mandatory when Type is 2. See Product Documentation (https://www.tencentcloud.com/document/product/614/103178?from_cn_redirect=1#rule) for rule writing details.Note: This field may return null, indicating that no valid values can be obtained. |
| Reason | String | Blocking reason. |
| Source | Integer | Rule Creation Source. 1. Console; 2. API; 3. Alarm notification |
| Operator | String | Operator. |
| Status | Integer | Rule Status. 0: Not yet effective; 1: In effect; 2: Expired |
| CreateTime | Integer | Rule Creation Time. |
| UpdateTime | Integer | Rule Update Time. |
Monitoring object
Used by actions: CreateAlarm, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicId | String | Yes | Log topic IDNote: This field may return null, indicating that no valid values can be obtained. |
| Query | String | Yes | Query statementNote: This field may return null, indicating that no valid values can be obtained. |
| Number | Integer | Yes | Serial number of alarm object, which is incremental from 1.Note: This field may return null, indicating that no valid values can be obtained. |
| StartTimeOffset | Integer | Yes | Offset of the query start time from the alarm execution time in minutes. The value cannot be positive. Maximum value: 0. Minimum value: -1440.Note: This field may return null, indicating that no valid values can be obtained. |
| EndTimeOffset | Integer | Yes | Offset of the query end time from the alarm execution time in minutes. The value cannot be positive and must be greater than StartTimeOffset. Maximum value: 0. Minimum value: -1440.Note: This field may return null, indicating that no valid values can be obtained. |
| LogsetId | String | Yes | Logset IDNote: This field may return null, indicating that no valid values can be obtained. |
| SyntaxRule | Integer | No | Search syntax rules; default value: 0.0: Lucene syntax; 1: CQL syntax.For detailed instructions, see Search Condition Syntax Rules Note: This field may return null, indicating that no valid values can be obtained. |
Alarm object
Used by actions: DescribeAlarms.
| Name | Type | Description |
|---|---|---|
| LogsetId | String | Logset ID |
| LogsetName | String | Logset name |
| TopicId | String | Log topic ID |
| TopicName | String | Log topic name |
| Query | String | Query statement |
| Number | Integer | Monitoring object number |
| StartTimeOffset | Integer | Offset of the query start time from the alarm execution time in minutes. The value cannot be positive. Value range: -1440–0. |
| EndTimeOffset | Integer | Offset of the query end time from the alarm execution time in minutes. The value cannot be positive and must be greater than StartTimeOffset. Value range: -1440–0. |
Details about an alarm notification group
Used by actions: DescribeAlertRecordHistory.
| Name | Type | Description |
|---|---|---|
| Name | String | Notification group name |
| AlarmNoticeId | String | Notification group ID |
Alarm record details
Used by actions: DescribeAlertRecordHistory.
| Name | Type | Required | Description |
|---|---|---|---|
| RecordId | String | Yes | Alarm record ID |
| AlarmId | String | Yes | Alarm policy ID |
| AlarmName | String | Yes | Alarm policy name |
| TopicId | String | Yes | ID of the monitored object |
| TopicName | String | Yes | Name of the monitored object |
| Region | String | Yes | Region of the monitored object |
| Trigger | String | Yes | Trigger condition |
| TriggerCount | Integer | Yes | Number of cycles for which the alarm lasts. An alarm will be triggered only after the trigger condition is met for the number of cycles specified by TriggerCount. |
| AlarmPeriod | Integer | Yes | Alarm notification frequency (minutes) |
| Notices | Array of AlertHistoryNotice | Yes | Notification group |
| Duration | Integer | Yes | Alarm duration (minutes) |
| Status | Integer | Yes | Alarm status. Valid values: 0 (uncleared), 1 (cleared), 2 (expired) |
| CreateTime | Integer | Yes | Alarm generation time, which is a Unix timestamp in ms |
| GroupTriggerCondition | Array of GroupTriggerConditionInfo | No | Group information corresponding to triggering by group Note: This field may return null, indicating that no valid values can be obtained. |
| AlarmLevel | Integer | No | Alarm severity. Valid values: 0 (Warn), 1 (Info), 2 (Critical)Note: This field may return null, indicating that no valid values can be obtained. |
| MonitorObjectType | Integer | No | Type of the monitored object0: The same object is specified for all statements. 1: An object is separately specified for each statement. Note: This field may return null, indicating that no valid values can be obtained. |
Multi-Dimensional analysis dimension
Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Analysis name Note: This field may return null, indicating that no valid values can be obtained. |
| Type | String | Yes | Type of data being analyzed. Valid values: query, field, originalNote: This field may return null, indicating that no valid values can be obtained. |
| Content | String | Yes | Analysis content Note: This field may return null, indicating that no valid values can be obtained. |
| ConfigInfo | Array of AlarmAnalysisConfig | No | Multi-dimensional analysis configuration. Supported when the type field of Analysis is query (custom){ "Key": "SyntaxRule", // Syntax rules"Value": "1" // 0: Lucene syntax, 1: CQL syntax} Supported when the Type field of Analysis is field (top5) { "Key": "QueryIndex", "Value": "-1" // -1: Custom, 1: Execute Statement 1, 2: Execute Statement 2},{ "Key": "CustomQuery", // Search statement. Valid and required when QueryIndex is -1 "Value": "* |
Authentication-free information
Used by actions: DescribeTopics.
| Name | Type | Required | Description |
|---|---|---|---|
| Operations | Array of String | No | Operation list supports trackLog (JS/HTTP log upload) and realtimeProducer (kafka protocol log upload). |
| Conditions | Array of ConditionInfo | No | Condition list |
Callback configuration
Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Body | String | Yes | Body during callback |
| Headers | Array of String | No | Headers during callbackNote: this field may return null, indicating that no valid values can be obtained. |
Information of the CKafka instance to ship to
Used by actions: CreateConsumer, DescribeConsumer, ModifyConsumer.
| Name | Type | Required | Description |
|---|---|---|---|
| Vip | String | Yes | CKafka VIP |
| Vport | String | Yes | CKafka Vport |
| InstanceId | String | Yes | CKafka instance ID |
| InstanceName | String | Yes | CKafka instance name |
| TopicId | String | Yes | CKafka topic ID |
| TopicName | String | Yes | CKafka topic name |
Column attribute of log analysis
Used by actions: GetAlarmLog, SearchLog.
| Name | Type | Description |
|---|---|---|
| Name | String | Column name |
| Type | String | Column attribute |
Compression configuration of shipped log
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| Format | String | Yes | Compression format. Valid values: gzip; lzop; snappy; none (no compression) |
Authentication-free condition information
Used by actions: DescribeTopics.
| Name | Type | Required | Description |
|---|---|---|---|
| Attributes | String | No | Condition attribute, currently supports only VpcID |
| Rule | Integer | No | Condition rule, 1: equal to, 2: not equal to |
| ConditionValue | String | No | Value of the corresponding condition attribute |
Collection rule configuration information
Used by actions: DescribeConfigs, DescribeMachineGroupConfigs.
| Name | Type | Description |
|---|---|---|
| ConfigId | String | Collection rule configuration ID |
| Name | String | Name of the collection rule configuration Note: This field may return null, indicating that no valid values can be obtained. |
| LogFormat | String | Log formatting method Note: this field may return null, indicating that no valid values can be obtained. |
| Path | String | Log collection path Note: this field may return null, indicating that no valid values can be obtained. |
| LogType | String | Type of collected logs.- json_log: JSON File Log (For more information, see Using JSON pattern to collect logs);- delimiter_log: Delimiter - File Logs (For more information, see Using delimiter pattern to collect logs);- minimalist_log: Single-line Full-text File Log (For more information, see Using single-line full-text pattern to collect logs);- fullregex_log: Single line full regular expression - File log (For more information, see Using single-line - complete regular expression pattern to collect logs);- multiline_log: Multiline Full-text File Log (For more information, see Using multi-line full-text pattern to collect logs);- multiline_fullregex_log: Multi-line complete regular expression - File Logs (For more information, see Using multi-line - complete regular expression pattern to collect logs);- user_define_log: Combined parsing (Suitable for logs with multiple nested formats, see Using combined parsing pattern to collect logs);- service_syslog: syslog collection (For more information, see Collect Syslog);- windows_event_log represents: Windows event logs (see Collecting Windows Event Logs (https://www.tencentcloud.com/document/product/614/96678?from_cn_redirect=1) for details.).Note: This field may return null, indicating that no valid values can be obtained. |
| ExtractRule | ExtractRuleInfo | Extraction rule. If ExtractRule is set, LogType must be setNote: this field may return null, indicating that no valid values can be obtained. |
| ExcludePaths | Array of ExcludePathInfo | Collection path blocklist Note: this field may return null, indicating that no valid values can be obtained. |
| Output | String | Log topic ID (TopicId) of collection configuration |
| UpdateTime | Timestamp | Update time Note: this field may return null, indicating that no valid values can be obtained. |
| CreateTime | Timestamp | Creation time |
| UserDefineRule | String | User-defined parsing strings, see Collecting Logs Using Combined Parsing Extraction Mode (https://www.tencentcloud.com/document/product/614/61310?from_cn_redirect=1) for details.Note: This field may return null, indicating that no valid values can be obtained. |
| AdvancedConfig | String | Advanced collection configuration. A JSON string, Key/Value definition as follows:- ClsAgentFileTimeout (timeout property), value range: an integer greater than or equal to 0, where 0 means no timeout- ClsAgentMaxDepth (maximum directory depth), value range: an integer greater than or equal to 0- ClsAgentParseFailMerge (merge logs that failed parsing), value range: true or falseSample:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}Default placeholder value in the console: {"ClsAgentDefault":0}Note: This field may return null, indicating that no valid values can be obtained. |
Shipping content
Used by actions: CreateConsumer, DescribeConsumer, ModifyConsumer.
| Name | Type | Required | Description |
|---|---|---|---|
| EnableTag | Boolean | Yes | Whether to deliver TAG information. When EnableTag is true, it indicates the delivery of TAG metadata.Note: This field may return null, indicating that no valid values can be obtained. |
| MetaFields | Array of String | Yes | List of metadata to ship. Supported metadata types: __SOURCE__, __FILENAME__, __TIMESTAMP__, __HOSTNAME__, and __PKGID__. Note: This field may return null, indicating that no valid values can be obtained. |
| TagJsonNotTiled | Boolean | No | When EnableTag is true, the TagJsonNotTiled field must be filled.TagJsonNotTiled is used to indicate whether tag information is JSON flattened.When TagJsonNotTiled is true, it is not flattened. Example:TAG information: {"TAG":{"fieldA":200,"fieldB":"text"}}Untiled: {"TAG":{"fieldA":200,"fieldB":"text"}}When TagJsonNotTiled is false, the data is tiled. Example:TAG information: {"TAG":{"fieldA":200,"fieldB":"text"}}Tiled: {"TAG.fieldA":200,"TAG.fieldB":"text"}Note: This field may return null, indicating that no valid values can be obtained. |
| TimestampAccuracy | Integer | No | Delivery timestamp precision, optional [1: second; 2: millisecond], default is 1.Note: This field may return null, indicating that no valid values can be obtained. |
| JsonType | Integer | No | Deliver in JSON format.JsonType is 0: Consistent with the original log, no escape. Example: Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}Deliver to CKafka: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}JsonType is 1: Escaped. Example:Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}Delivered to CKafka: {"a":"aa","b":"{"b1":"b1b1", "c1":"c1c1"}"}Note: This field may return null, indicating that no valid values can be obtained. |
Format configuration of shipped log content
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| Format | String | Yes | Content format. Valid values: json, csv |
| Csv | CsvInfo | No | CSV format content description Note: this field may return null, indicating that no valid values can be obtained. |
| Json | JsonInfo | No | JSON format content description Note: this field may return null, indicating that no valid values can be obtained. |
| Parquet | ParquetInfo | No | Parquet format descriptionNote: This field may return null, indicating that no valid value can be obtained. |
COS import configuration information.
Used by actions: DescribeCosRecharges.
| Name | Type | Description |
|---|---|---|
| Id | String | COS import configuration ID. Note: This field may return null, indicating that no valid values can be obtained. |
| TopicId | String | ID of the log topic. Note: This field may return null, indicating that no valid values can be obtained. |
| LogsetId | String | ID of the logset. Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | COS import task name. Note: This field may return null, indicating that no valid values can be obtained. |
| Bucket | String | COS bucket. Note: This field may return null, indicating that no valid values can be obtained. |
| BucketRegion | String | Region where the COS bucket is located. Note: This field may return null, indicating that no valid values can be obtained. |
| Prefix | String | The prefix of the folder where COS files are located. Note: This field may return null, indicating that no valid values can be obtained. |
| LogType | String | The type of log collected. json_log: JSON logs; delimiter_log: separator logs; minimalist_log: full text in a single lineDefault value: minimalist_logNote: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Status. 0: Created, 1: Running, 2: Stopped, 3: Completed, 4: Run failedNote: This field may return null, indicating that no valid values can be obtained. |
| Enable | Integer | Whether the configuration is enabled. 0: Not enabled, 1: EnabledNote: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | Update time. Note: This field may return null, indicating that no valid values can be obtained. |
| Progress | Integer | Progress in percentage. Note: This field may return null, indicating that no valid values can be obtained. |
| Compress | String | Valid values: "" (default), "gzip", "lzop", "snappy" Note: This field may return null, indicating that no valid values can be obtained. |
| ExtractRuleInfo | ExtractRuleInfo | See the description of the ExtractRuleInfo structure.Note: This field may return null, indicating that no valid values can be obtained. |
CSV content description
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| PrintKey | Boolean | Yes | Whether to print key on the first row of the CSV file |
| Keys | Array of String | Yes | Names of keys Note: this field may return null, indicating that no valid values can be obtained. |
| Delimiter | String | Yes | Field delimiter |
| EscapeChar | String | Yes | Escape character used to enclose any field delimiter in field content. You can enter only a single quotation mark, double quotation mark, or an empty string. |
| NonExistingField | String | Yes | Content used to populate non-existing fields |
Information about the resource for data processing
Used by actions: CheckFunction, CreateDataTransform, DescribeDataTransformInfo, ModifyDataTransform.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicId | String | Yes | Target topic ID |
| Alias | String | Yes | Alias |
Basic information of a data processing task
Used by actions: DescribeDataTransformInfo.
| Name | Type | Description |
|---|---|---|
| Name | String | Data processing task name |
| TaskId | String | Data processing task ID |
| EnableFlag | Integer | Task status. Valid values: 1 (enabled) and 2 (disabled). |
| Type | Integer | Task type. Valid values: 1 (DSL) and 2 (SQL). |
| SrcTopicId | String | Source log topic |
| Status | Integer | Current task status. Valid values: 1 (preparing), 2 (in progress), 3 (being stopped), and 4 (stopped). |
| CreateTime | String | Task creation time |
| UpdateTime | String | Last modified time |
| LastEnableTime | String | Last enabled time. If you need to rebuild a cluster, modify this time. |
| SrcTopicName | String | Log topic name |
| LogsetId | String | Logset ID |
| DstResources | Array of DataTransformResouceInfo | Target topic ID and alias of the data processing task |
| EtlContent | String | Logical function for data processing |
Key-value index auto-configuration enables automatic addition of fields from logs into the key-value index, including subsequently added fields in the logs.
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | Boolean | No | Key-Value Index Auto-Config Switch Note: This field may return null, indicating that no valid values can be obtained. |
Windows event log collection configuration
Used by actions: CreateConfig, CreateCosRecharge, DescribeCosRecharges, ModifyConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| EventChannel | String | Yes | Event channel, supports Application, Security, Setup, System, ALL |
| TimeType | Integer | Yes | Time type, 1: User-defined, 2: Current time |
| Timestamp | Integer | No | Time, when choosing custom time type, a specific time is required |
| EventIDs | Array of String | No | Event ID filter list |
Blocklist path information
Used by actions: CreateConfig, DescribeConfigs, DescribeMachineGroupConfigs, ModifyConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Type. Valid values: File, Path |
| Value | String | Yes | Specific content corresponding to Type |
Log export information
Used by actions: DescribeExports.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Log topic ID |
| ExportId | String | Log export task ID |
| Query | String | Log export query statement |
| FileName | String | Log export filename |
| FileSize | Integer | Log file size |
| Order | String | Log export time sorting |
| Format | String | Log export format |
| Count | Integer | Number of logs to be exported |
| Status | String | Log download status. Valid values: Processing, Completed, Failed, Expired (three-day validity period), and Queuing. |
| From | Integer | Log export start time |
| To | Integer | Log export end time |
| CosPath | String | Log export path, valid for one hour. Please download using this path as soon as possible. |
| CreateTime | String | Log export creation time |
| SyntaxRule | Integer | Syntax rules. The default value is 0.0: Lucene syntax, 1: CQL syntax. |
Log extraction rule
Used by actions: CreateConfig, CreateCosRecharge, DescribeConfigs, DescribeCosRecharges, DescribeMachineGroupConfigs, ModifyConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| TimeKey | String | No | Key name for the time field. TikeKey and TimeFormat must appear in pairsNote: This field may return null, indicating that no valid values can be obtained. |
| TimeFormat | String | No | Time field format. For more information, please see the output parameters of the time format description of the strftime function in C languageNote: this field may return null, indicating that no valid values can be obtained. |
| Delimiter | String | No | Delimiter for log type. Valid only when LogType is delimiter_logNote: This field may return null, indicating that no valid values can be obtained. |
| LogRegex | String | No | Full log matching rule. Valid only if LogType is fullregex_logNote: This field may return null, indicating that no valid values can be obtained. |
| BeginRegex | String | No | Line beginning matching rule, valid only if LogType is multiline_log or fullregex_logNote: This field may return null, indicating that no valid values can be obtained. |
| Keys | Array of String | No | Key name of each extracted field. An empty key indicates discarding the field. Valid only if LogType is delimiter_log. json_log logs use the key of JSON itself. Limited to 100.Note: This field may return null, indicating that no valid values can be obtained. |
| FilterKeyRegex | Array of KeyRegexInfo | No | Log filter rule list (previous version), keys to be filtered in the log and their corresponding regex.Note: For LogListener version 2.9.3 and later, it is recommended to use the AdvanceFilterRules configuration for log filtering.Note: This field may return null, indicating that no valid values can be obtained. |
| UnMatchUpLoadSwitch | Boolean | No | Whether to upload the logs that failed to be parsed. Valid values: true: yes; false: noNote: this field may return null, indicating that no valid values can be obtained. |
| UnMatchLogKey | String | No | Unmatched log key Note: this field may return null, indicating that no valid values can be obtained. |
| Backtracking | Integer | No | Backtracking data volume under incremental collection pattern, default -1 indicates full collection; other non-negative numbers indicate incremental collection (collect logs backward from the latest position by ${Backtracking} bytes) with a maximum support of 1073741824 (1G).Note: This field may return null, indicating that no valid values can be obtained. |
| IsGBK | Integer | No | Whether to be encoded in GBK format. Valid values: 0 (No) and 1 (Yes).Note: This field may return null, indicating that no valid values can be obtained. |
| JsonStandard | Integer | No | Whether to be formatted as JSON (standard). Valid values: 0 (No) and 1 (Yes).Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | String | No | Syslog protocol. Valid values: tcp, udp.This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained. |
| Address | String | No | Listening address and port specified by the syslog collection. Format: [ip]:[port]. Example: 127.0.0.1:9000. This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained. |
| ParseProtocol | String | No | rfc3164: Resolve logs by using the RFC 3164 protocol during the syslog collection.rfc5424: Resolve logs by using the RFC 5424 protocol during the syslog collection.auto: Automatically match either the RFC 3164 or RFC 5424 protocol.This field can be used when you create or modify collection rule configurations. Note: This field may return null, indicating that no valid values can be obtained. |
| MetadataType | Integer | No | Metadata type. Valid values: 0: Do not use metadata. 1: Use machine group metadata. 2: Use user-defined metadata. 3: Use the collection path to extract metadata. |
| PathRegex | String | No | Regular expression of the collection configuration path, which is required when MetadataType is set to 3Note: This field may return null, indicating that no valid values can be obtained. |
| MetaTags | Array of MetaTagInfo | No | User-defined metadata, which is required when MetadataType is set to 2. |
| EventLogRules | Array of EventLog | No | Windows event log collection |
Filter
Used by actions: DescribeAlarmNotices, DescribeAlarmShields, DescribeAlarms, DescribeAlertRecordHistory, DescribeConfigs, DescribeDataTransformInfo, DescribeLogsets, DescribeMachineGroups, DescribeScheduledSqlInfo, DescribeShippers, DescribeTopics.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Field to be filtered |
| Values | Array of String | Yes | Value to be filtered |
Filter rule for shipped log
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Filter rule key |
| Regex | String | Yes | Filter rule |
| Value | String | Yes | Filter rule value |
Full-Text index configuration
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| CaseSensitive | Boolean | Yes | Case sensitivity |
| Tokenizer | String | Yes | Separator of the full-text index. Each character represents a separator. Only symbols, \n\t\r, and escape character \ are supported. Note: \n\t\r can be directly enclosed in double quotes as the input parameter without escaping. When debugging with API Explorer, use the JSON parameter input method to avoid repeated escaping of \n\t\r. |
| ContainZH | Boolean | No | Whether Chinese characters are contained Note: this field may return null, indicating that no valid values can be obtained. |
Condition of triggering by group
Used by actions: DescribeAlertRecordHistory.
| Name | Type | Description |
|---|---|---|
| Key | String | Name of the field for triggering by group |
| Value | String | Value of the field for triggering by group |
Highlighted Log Description Information
Used by actions: DescribeLogContext.
| Name | Type | Description |
|---|---|---|
| Key | String | Highlighted Log Key |
| Values | Array of String | Highlighted Syntax |
Histogram details
Used by actions: DescribeLogHistogram.
| Name | Type | Description |
|---|---|---|
| Count | Integer | The number of logs within the statistical period |
| BTime | Integer | Unix timestamp rounded by period, in milliseconds |
JSON type description
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| EnableTag | Boolean | Yes | Enablement flag |
| MetaFields | Array of String | Yes | List of metadata. Supported metadata types: SOURCE, FILENAME, TIMESTAMP, HOSTNAME. Note: This field may return null, indicating that no valid values can be obtained. |
| JsonType | Integer | No | JSON format for shipping. 0: String format; 1: Structured format.Note: This field may return null, indicating that no valid values can be obtained. |
Kafka consumer content
Used by actions: DescribeKafkaConsumer, ModifyKafkaConsumer, OpenKafkaConsumer.
| Name | Type | Required | Description |
|---|---|---|---|
| Format | Integer | Yes | Consumption data format. Valid values: 0 (original content) and 1 (JSON). |
| EnableTag | Boolean | Yes | Whether to ship tag information This parameter does not need to be set when Format is set to 0. |
| MetaFields | Array of String | Yes | Metadata information list. Valid values: __SOURCE__, __FILENAME__, __TIMESTAMP__, __HOSTNAME__, and __PKGID__. This parameter does not need to be set when Format is set to 0. |
| TagTransaction | Integer | No | Tag data processing mode: 1: Do not tile (default); 2: Tile. Untiled example: TAG information: {"TAG":{"fieldA":200,"fieldB":"text"}}Untiled: {"TAG":{"fieldA":200,"fieldB":"text"}}Tiled example: TAG information: {"TAG":{"fieldA":200,"fieldB":"text"}}Tiled: {"TAG.fieldA":200,"TAG.fieldB":"text"}Note: This field may return null, indicating that no valid values can be obtained. |
| JsonType | Integer | No | JSON data format: 1: Not escaped (default format) 2: Escaped Deliver in JSON format.JsonType is 1: Consistent with the original log, not escaped. Example: Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}Deliver to CKafka: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}JsonType is 2: escaped. Example:Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}Deliver to CKafka: {"a":"aa","b":"{"b1":"b1b1", "c1":"c1c1"}"} |
Kafka access protocol
Used by actions: CheckRechargeKafkaServer, CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge.
| Name | Type | Required | Description |
|---|---|---|---|
| Protocol | String | No | Protocol type, including plaintext, sasl_plaintext, or sasl_ssl. sasl_ssl is recommended for encrypted connections and user authentication.Required input parameters Note: This field may return null, indicating that no valid values can be obtained. |
| Mechanism | String | No | Encryption type, supports PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.Required when the Protocol is sasl_plaintext or sasl_ssl.Note: This field may return null, indicating that no valid values can be obtained. |
| UserName | String | No | UsernameRequired when the Protocol is sasl_plaintext or sasl_ssl.Note: This field may return null, indicating that no valid values can be obtained. |
| Password | String | No | User PasswordRequired when the Protocol is sasl_plaintext or sasl_ssl.Note: This field may return null, indicating that no valid values can be obtained. |
Kafka data import configuration
Used by actions: DescribeKafkaRecharges.
| Name | Type | Description |
|---|---|---|
| Id | String | ID of the Kafka data subscription configuration.Note: This field may return null, indicating that no valid values can be obtained. |
| TopicId | String | Log topic ID Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | Kafka data import task name Note: This field may return null, indicating that no valid values can be obtained. |
| KafkaType | Integer | Kafka type. Valid values: 0 (Tencent Cloud CKafka) and 1 (customer's Kafka). Note: This field may return null, indicating that no valid values can be obtained. |
| KafkaInstance | String | CKafka instance ID, which is required when KafkaType is set to 0Note: This field may return null, indicating that no valid values can be obtained. |
| ServerAddr | String | Service address Note: This field may return null, indicating that no valid values can be obtained. |
| IsEncryptionAddr | Boolean | Whether the service address uses an encrypted connection Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | KafkaProtocolInfo | Encryption access protocol, which is required when IsEncryptionAddr is set to true |
| UserKafkaTopics | String | List of Kafka topics to import data from. Separate multiple topics with commas (,). Note: This field may return null, indicating that no valid values can be obtained. |
| ConsumerGroupName | String | Kafka consumer group name Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Status, 1: running; 2: paused.Note: This field may return null, indicating that no valid values can be obtained. |
| Offset | Integer | Import data position, -2: earliest (default), -1: latestNote: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | Update time Note: This field may return null, indicating that no valid values can be obtained. |
| LogRechargeRule | LogRechargeRuleInfo | Log import rule Note: This field may return null, indicating that no valid values can be obtained. |
Log keys to be filtered and the corresponding regex
Used by actions: CreateConfig, CreateCosRecharge, DescribeCosRecharges, ModifyConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Log key to be filtered |
| Regex | String | Yes | Filter rule regex corresponding to key |
Field information of key value or metafield index
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Name of the field for which you want to configure a key-value or metadata field index. The name can contain letters, digits, underscores, and symbols -./@ and cannot start with an underscore. Note: For a metadata field, set its Key to be consistent with the one for log uploading, without prefixing it with TAG.. TAG. will be prefixed automatically for display in the console.2. The total number of keys in key-value indexes ( KeyValue) and metadata field indexes (Tag) cannot exceed 300.3. The number of levels in Key cannot exceed 10. Example: a.b.c.d.e.f.g.h.j.k4. JSON parent and child fields (such as “a” and “a.b”) cannot be contained at the same time. |
| Value | ValueInfo | Yes | Field index description information |
Log context information
Used by actions: DescribeLogContext.
| Name | Type | Description |
|---|---|---|
| Source | String | Log source device |
| Filename | String | Collection path |
| Content | String | Log content |
| PkgId | String | Log package number |
| PkgLogId | Integer | Log number in log package |
| BTime | Integer | Log timestamp |
| HostName | String | Source host name of logs Note: This field may return null, indicating that no valid value was found. |
| RawLog | String | Raw log (this parameter has a value only when an exception occurred while creating indexes for logs). Note: This field may return null, indicating that no valid values can be obtained. |
| IndexStatus | String | The cause of index creation exception (this parameter has a value only when an exception occurred while creating indexes for logs). Note: This field may return null, indicating that no valid values can be obtained. |
| HighLights | Array of HighLightItem | Highlighted description of log contentNote: This field may return null, indicating that no valid values can be obtained. |
Log result information
Used by actions: GetAlarmLog, SearchLog.
| Name | Type | Description |
|---|---|---|
| Time | Integer | Log time in milliseconds |
| TopicId | String | Log topic ID |
| TopicName | String | Log topic name |
| Source | String | Log source IP |
| FileName | String | Log filename |
| PkgId | String | ID of the request package for log reporting |
| PkgLogId | String | Log ID in request package |
| LogJson | String | Serialized JSON string of log content Note: this field may return null, indicating that no valid values can be obtained. |
| HostName | String | Source host name of logs Note: This field may return null, indicating that no valid value was found. |
| RawLog | String | Raw log (this parameter has a value only when an exception occurred while creating indexes for logs). Note: This field may return null, indicating that no valid values can be obtained. |
| IndexStatus | String | The cause of index creation exception (this parameter has a value only when an exception occurred while creating indexes for logs). Note: This field may return null, indicating that no valid values can be obtained. |
Key-Value pair in log
Used by actions: GetAlarmLog, SearchLog.
| Name | Type | Description |
|---|---|---|
| Key | String | Log key |
| Value | String | Log value |
LogItem array
Used by actions: GetAlarmLog, SearchLog.
| Name | Type | Description |
|---|---|---|
| Data | Array of LogItem | Key-Value pair returned in analysis result |
Log import rule
Used by actions: CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge.
| Name | Type | Required | Description |
|---|---|---|---|
| RechargeType | String | Yes | Import type. Valid values: json_log (JSON logs), minimalist_log (single-line full text), and fullregex_log (single-line full regex) |
| EncodingFormat | Integer | Yes | Encoding format. Valid values: 0 (default, UTF-8) and 1 GBK). |
| DefaultTimeSwitch | Boolean | Yes | Whether to use the default time. Valid values: true (default) and false. |
| LogRegex | String | No | Full log matching rule, which is valid only if RechargeType is fullregex_log.Note: This field may return null, indicating that no valid values can be obtained. |
| UnMatchLogSwitch | Boolean | No | Whether to upload the logs that failed to be parsed. Valid values: true and false. |
| UnMatchLogKey | String | No | Key of the log that failed to be parsed Note: This field may return null, indicating that no valid values can be obtained. |
| UnMatchLogTimeSrc | Integer | No | Time source of the log that failed to be parsed. Valid values: 0 (current system time) and 1 (Kafka message timestamp). Note: This field may return null, indicating that no valid values can be obtained. |
| DefaultTimeSrc | Integer | No | Default time source. Valid values: 0 (current system time) and 1 (Kafka message timestamp). Note: This field may return null, indicating that no valid values can be obtained. |
| TimeKey | String | No | Time field Note: This field may return null, indicating that no valid values can be obtained. |
| TimeRegex | String | No | Time regular expression Note: This field may return null, indicating that no valid values can be obtained. |
| TimeFormat | String | No | Time field format Note: This field may return null, indicating that no valid values can be obtained. |
| TimeZone | String | No | Time zone Note: This field may return null, indicating that no valid values can be obtained. |
| Metadata | Array of String | No | Metadata information. Kafka supports import of kafka_topic, kafka_partition, kafka_offset, and kafka_timestamp. Note: This field may return null, indicating that no valid values can be obtained. |
| Keys | Array of String | No | List of log keys, which is required when RechargeType is set to full_regex_logNote: This field may return null, indicating that no valid values can be obtained. |
Logset information
Used by actions: DescribeLogsets.
| Name | Type | Description |
|---|---|---|
| LogsetId | String | Logset ID |
| LogsetName | String | Logset name |
| CreateTime | String | Creation time |
| AssumerName | String | Cloud product identifier. If the logset is created by another cloud product, this field returns the name of the cloud product, such as CDN or TKE.Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of Tag | Tag bound to logset Note: this field may return null, indicating that no valid values can be obtained. |
| TopicCount | Integer | Number of log topics in logset |
| RoleName | String | If AssumerName is not empty, it indicates the service provider who creates the logset. |
Machine group information
Used by actions: DescribeConfigMachineGroups, DescribeMachineGroups.
| Name | Type | Description |
|---|---|---|
| GroupId | String | Machine group ID |
| GroupName | String | Machine group name |
| MachineGroupType | MachineGroupTypeInfo | Machine group type |
| CreateTime | String | Creation time |
| Tags | Array of Tag | List of tags bound to machine group Note: this field may return null, indicating that no valid values can be obtained. |
| AutoUpdate | String | Whether to enable automatic update for the machine group Note: this field may return null, indicating that no valid values can be obtained. |
| UpdateStartTime | String | Update start time. We recommend you update LogListener during off-peak hours. Note: this field may return null, indicating that no valid values can be obtained. |
| UpdateEndTime | String | Update end time. We recommend you update LogListener during off-peak hours. Note: this field may return null, indicating that no valid values can be obtained. |
| ServiceLogging | Boolean | Whether to enable the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset cls_service_logging and the loglistener_status, loglistener_alarm, and loglistener_business log topics will be created, which will not incur fees.Note: this field may return null, indicating that no valid values can be obtained. |
| DelayCleanupTime | Integer | Regular cleanup time for offline machines in the machine group Note: This field may return null, indicating that no valid values can be obtained. |
| MetaTags | Array of MetaTagInfo | Metadata information list of a machine group |
| OSType | Integer | Operating system type, 0: Linux, 1: Windows |
Machine group type description
Used by actions: AddMachineGroupInfo, CreateMachineGroup, DeleteMachineGroupInfo, DescribeConfigMachineGroups, DescribeMachineGroups, ModifyMachineGroup.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Machine group type. Valid values: ip: the IP addresses of collection machines are stored in Values of the machine group; label: the tags of the machines are stored in Values of the machine group |
| Values | Array of String | Yes | Machine description list |
Machine status information
Used by actions: DescribeMachines.
| Name | Type | Description |
|---|---|---|
| Ip | String | Machine IP |
| InstanceID | String | Machine instance IDNote: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Machine status. Valid values: 0: exceptional; 1: normal |
| OfflineTime | String | Machine disconnection time. If the value is empty, the machine is normal. If the machine is exceptional, a specific value will be returned. |
| AutoUpdate | Integer | Whether to enable automatic update for the machine. Valid values: 0: no; 1: yes |
| Version | String | Current machine version number |
| UpdateStatus | Integer | Machine upgrade status. 0: Upgrade successful; 1: Upgrading; -1: Upgrade failed. |
| ErrCode | Integer | Machine upgrade result identifier.0: Success; 1200: Upgrade successful; Other values indicate exceptions. |
| ErrMsg | String | Machine upgrade result information."ok": Success; "update success": Upgrade successful; Other values indicate the reason for failure. |
Metadata information
Used by actions: CreateConfig, CreateCosRecharge, CreateMachineGroup, DescribeConfigMachineGroups, DescribeCosRecharges, DescribeMachineGroups, ModifyConfig, ModifyMachineGroup.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Metadata key |
| Value | String | No | Metadata value |
Filters
Used by actions: CreateScheduledSql, DescribeScheduledSqlInfo, ModifyScheduledSql.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Metric NameNote: This field may return null, indicating that no valid values can be obtained. |
| Value | String | Yes | Metric content Note: This field may return null, indicating that no valid values can be obtained. |
Monitoring task execution time point in alarm policy
Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Valid values:Period: periodic executionFixed: scheduled execution |
| Time | Integer | Yes | Execution interval or scheduled time point in minutes. Value range: 1–1440. |
Multiple trigger conditions.
Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.
| Name | Type | Required | Description |
|---|---|---|---|
| Condition | String | No | Trigger condition.Note: This field may return null, indicating that no valid values can be obtained. |
| AlarmLevel | Integer | No | Alarm severity. 0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical). Note: This field may return null, indicating that no valid values can be obtained. |
Log topic search information
Used by actions: SearchLog.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicId | String | No | ID of the log topic to be searched for |
| Context | String | No | You can pass through the Context value (validity: 1 hour) returned by the last API to continue to get logs, which can get up to 10,000 raw logs. |
Alarm notification recipient information
Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.
| Name | Type | Required | Description |
|---|---|---|---|
| ReceiverType | String | Yes | Recipient type. Valid values:Uin: user IDGroup: user group IDCurrently, other recipient types are not supported. |
| ReceiverIds | Array of Integer | Yes | Recipient |
| ReceiverChannels | Array of String | Yes | Notification methodEmail: emailSms: SMSWeChat: WeChatPhone: phone |
| StartTime | String | No | Start time for allowed message receipt |
| EndTime | String | No | End time for allowed message receipt |
| Index | Integer | No | Index |
Notification rules
Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.
| Name | Type | Required | Description |
|---|---|---|---|
| NoticeReceivers | Array of NoticeReceiver | No | Alarms notification template recipient informationNote: This field may return null, indicating that no valid values can be obtained. |
| WebCallbacks | Array of WebCallback | No | Alarms notification template callback informationNote: This field may return null, indicating that no valid values can be obtained. |
| Rule | String | No | Matching rules. Note: This field may return null, indicating that no valid values can be obtained. |
Parquet contents
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| ParquetKeyInfo | Array of ParquetKeyInfo | Yes | ParquetKeyInfo array |
Parquet content description
Used by actions: CreateShipper, DescribeShippers, ModifyShipper.
| Name | Type | Required | Description |
|---|---|---|---|
| KeyName | String | Yes | Key name |
| KeyType | String | Yes | Supported data types: string, boolean, int32, int64, float, and double |
| KeyNonExistingField | String | Yes | Assignment information returned upon resolution failure Note: This field may return null, indicating that no valid value can be obtained. |
Log topic partition information
Used by actions: DescribePartitions, MergePartition, SplitPartition.
| Name | Type | Description |
|---|---|---|
| PartitionId | Integer | Partition ID |
| Status | String | Partition status. Valid values: readwrite, readonly |
| InclusiveBeginKey | String | Partition hash start key |
| ExclusiveEndKey | String | Partition hash end key |
| CreateTime | String | Partition creation time |
| LastWriteTime | String | Last modified of read-only partition Note: this field may return null, indicating that no valid values can be obtained. |
Preview data details
Used by actions: CreateDataTransform.
| Name | Type | Required | Description |
|---|---|---|---|
| LogContent | String | Yes | Log content |
| LineNum | Integer | Yes | Line number |
| DstTopicId | String | No | Target log topic |
| FailReason | String | No | Error code. An empty string "" indicates no error. |
| Time | String | No | Log timestamp |
| DstTopicName | String | No | Target topic name Note: This field may return null, indicating that no valid values can be obtained. |
Index rule. At least one of the FullText, KeyValue, and Tag parameters must be valid.
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| FullText | FullTextInfo | No | Full-text index configuration. If empty, full-text indexing is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| KeyValue | RuleKeyValueInfo | No | Key-value index configuration. If empty, key-value indexing is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| Tag | RuleTagInfo | No | Metadata field index configuration. If empty, metadata field indexing is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| DynamicIndex | DynamicIndex | No | Key-value index automatic configuration. If empty, the feature is not enabled.Once enabled, fields within logs are automatically added to the key-value index, including fields added to logs subsequently. Note: This field may return null, indicating that no valid values can be obtained. |
Key-Value index configuration
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| CaseSensitive | Boolean | Yes | Case sensitivity |
| KeyValues | Array of KeyValueInfo | No | Key-value pair information of the index to be created |
Metafield index configuration
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| CaseSensitive | Boolean | Yes | Case sensitivity |
| KeyValues | Array of KeyValueInfo | Yes | Field information in the metafield index configuration |
Resource information for ScheduledSql
Used by actions: CreateScheduledSql, DescribeScheduledSqlInfo, ModifyScheduledSql.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicId | String | Yes | Target topic ID |
| Region | String | No | Region information for the topic |
| BizType | Integer | No | Topic type: 0 for log topic, and 1 for metric topic |
| MetricName | String | No | Metric name. When BizType is 1, MetricName needs to be specified. |
| MetricNames | Array of String | No | Metric NameWhen BizType is 1, prioritize using the MetricNames field. Multiple metrics can only be filled in the MetricNames field, while it's recommended to fill a single metric in the MetricName field. |
| MetricLabels | Array of String | No | Metric dimension. Not accept time type. |
| CustomTime | String | No | Metric timestamp. The default value is the left time point of the SQL query time range, but you can also specify other fields (The type is uinx time, TimeStamp, and precision millisecond) as the metric timestamp. |
| CustomMetricLabels | Array of MetricLabel | No | In addition to MetricLabels, this parameter can be used to supplement static dimensions for the metric. Dimension names must start with a letter or underscore, followed by letters, digits, or underscores, with a length less than or equal to 1024 bytes. |
ScheduledSql task details
Used by actions: DescribeScheduledSqlInfo.
| Name | Type | Description |
|---|---|---|
| TaskId | String | ScheduledSql task id |
| Name | String | ScheduledSql task name |
| SrcTopicId | String | Source Log Topic ID |
| SrcTopicName | String | Source Log Topic Name |
| DstResource | ScheduledSqlResouceInfo | Scheduled SQL analysis of target topic |
| CreateTime | String | Creation Time |
| UpdateTime | String | Task Update Time |
| Status | Integer | Task status: 1: Running 2: Stop 3: Exception - Source log topic not found 4: Exception - target topic not found5: Access permission issue 6: Internal failure 7: Other faults |
| EnableFlag | Integer | Task status: 1 Enabled, 2 Disabled |
| ScheduledSqlContent | String | Queries statements |
| ProcessStartTime | String | Schedule Start Time |
| ProcessType | Integer | Schedule Type: 1 Continuous Running 2 Specified Time Range |
| ProcessEndTime | String | Schedule End Time, required when process_type=2 |
| ProcessPeriod | Integer | Scheduling Interval (Minutes) |
| ProcessTimeWindow | String | Query Time Window. @m-15m, @m, meaning the last 15 minutes |
| ProcessDelay | Integer | Execution Delay (Seconds) |
| SrcTopicRegion | String | Source Topic ID Region Information |
| SyntaxRule | Integer | Syntax Rules: 0 Lucene syntax, 1 CQL syntaxNote: This field may return null, indicating that no valid values can be obtained. |
Error information for multi-log topic search
Used by actions: SearchLog.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Log topic IDNote: This field may return null, indicating that no valid values can be obtained. |
| ErrorMsg | String | Error MessageNote: This field may return null, indicating that no valid values can be obtained. |
| ErrorCodeStr | String | Error CodeNote: This field may return null, indicating that no valid values can be obtained. |
Multiple log topic search for topic information
Used by actions: SearchLog.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Log Topic ID |
| Period | Integer | Log storage lifetime |
| Context | String | You can pass through the Context value returned by this API to continue to get more logs. Expire time: 1 hour.Note: This field may return null, indicating that no valid values can be obtained. |
Multi-topic search return information
Used by actions: SearchLog.
| Name | Type | Description |
|---|---|---|
| Errors | Array of SearchLogErrors | Error information for multi-log topic searchNote: This field may return null, indicating that no valid values can be obtained. |
| Infos | Array of SearchLogInfos | Information for each log topic in multi-log topic searchNote: This field may return null, indicating that no valid values can be obtained. |
Shipping rule
Used by actions: DescribeShippers.
| Name | Type | Description |
|---|---|---|
| ShipperId | String | Shipping rule ID |
| TopicId | String | Log topic ID |
| Bucket | String | Bucket address shipped to |
| Prefix | String | Shipping prefix directory |
| ShipperName | String | Shipping rule name |
| Interval | Integer | Shipping time interval in seconds |
| MaxSize | Integer | Maximum size of shipped file in MB |
| Status | Boolean | Whether it takes effect |
| FilterRules | Array of FilterRuleInfo | Filter rule for shipped log Note: this field may return null, indicating that no valid values can be obtained. |
| Partition | String | Partition rule of shipped log, which can be represented in strftime time format |
| Compress | CompressInfo | Compression configuration of shipped log Note: this field may return null, indicating that no valid values can be obtained. |
| Content | ContentInfo | Format configuration of shipped log content Note: this field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time of shipped log |
| FilenameMode | Integer | Shipping file naming configuration. Valid values: 0 (by random number); 1 (by shipping time). Default value: 0.Note: This field may return null, indicating that no valid values can be obtained. |
| StartTime | Integer | Start time for data shipping Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | Integer | End time for data shipping Note: This field may return null, indicating that no valid values can be obtained. |
| Progress | Float | Progress of historical data shipping (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained. |
| RemainTime | Integer | Remaining time required for shipping all historical data (valid only when the selected data scope contains historical data) Note: This field may return null, indicating that no valid values can be obtained. |
| HistoryStatus | Integer | Status of historical data shipping. Valid values: 0: Real-time data is being shipped. 1: The system is preparing for historical data shipping. 2: Historical data is being shipped. 3: An error occurred while shipping historical data. 4: Historical data shipping ended. Note: This field may return null, indicating that no valid values can be obtained. |
| StorageType | String | COS bucket type Note: This field may return null, indicating that no valid values can be obtained. |
Shipping task information
Used by actions: DescribeShipperTasks.
| Name | Type | Description |
|---|---|---|
| TaskId | String | Shipping task ID |
| ShipperId | String | Shipping information ID |
| TopicId | String | Log topic ID |
| RangeStart | Integer | Start timestamp of the current batch of shipped logs in milliseconds |
| RangeEnd | Integer | End timestamp of the current batch of shipped logs in milliseconds |
| StartTime | Integer | Start timestamp of the current shipping task in milliseconds |
| EndTime | Integer | End timestamp of the current shipping task in milliseconds |
| Status | String | Result of the current shipping task. Valid values: success, running, failed |
| Message | String | Result details |
Description of the tag pair bound to a resource instance when it is created
Used by actions: CreateAlarm, CreateLogset, CreateMachineGroup, CreateTopic, DescribeConfigMachineGroups, DescribeLogsets, DescribeMachineGroups, DescribeTopics, ModifyAlarm, ModifyLogset, ModifyMachineGroup, ModifyTopic.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | The tag key. Note: This field may return null, indicating that no valid values can be obtained. |
| Value | String | Yes | The tag value. Note: This field may return null, indicating that no valid values can be obtained. |
Log topic extended information
Used by actions: DescribeTopics.
| Name | Type | Required | Description |
|---|---|---|---|
| AnonymousAccess | AnonymousInfo | No | Log topic authentication-free configuration information |
Basic Topic Information
Used by actions: DescribeTopics.
| Name | Type | Description |
|---|---|---|
| LogsetId | String | Logset ID |
| TopicId | String | Topic ID |
| TopicName | String | Topic Name |
| PartitionCount | Integer | Number of topic partitions |
| Index | Boolean | Whether the topic has indexing enabled (the topic type must be log topic) |
| AssumerName | String | Cloud product identifier. When the topic is created by other cloud products, this field displays the name of the cloud product, such as CDN, TKE.Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time |
| Status | Boolean | Whether the topic has log collection enabled. true: collection enabled; false: collection disabled.Log collection is enabled by default when creating a log topic, and this field can be modified by calling ModifyTopic through the SDK.The console currently does not support modifying this parameter. |
| Tags | Array of Tag | Tag information bound to the topicNote: This field may return null, indicating that no valid values can be obtained. |
| AutoSplit | Boolean | Whether automatic split is enabled for this topic Note: this field may return null, indicating that no valid values can be obtained. |
| MaxSplitPartitions | Integer | Maximum number of partitions to split into for this topic if automatic split is enabled Note: this field may return null, indicating that no valid values can be obtained. |
| StorageType | String | Storage type of the topicNote: This field may return null, indicating that no valid values can be obtained. |
| Period | Integer | Lifecycle in days. Value range: 1-3600 (3640 indicates permanent retention) Note: This field may return null, indicating that no valid value was found. |
| SubAssumerName | String | Cloud product sub-identifier. If the log topic is created by another cloud product, this field returns the name of the cloud product and its log type, such as TKE-Audit or TKE-Event. Some products only return the cloud product identifier (AssumerName), without this field.Note: This field may return null, indicating that no valid values can be obtained. |
| Describes | String | Topic description Note: This field may return null, indicating that no valid values can be obtained. |
| HotPeriod | Integer | Enable log sinking, with the lifecycle of standard storage, where hotPeriod < Period.For standard storage, hotPeriod is used, and for infrequent access storage, it is Period-hotPeriod. (The topic type must be a log topic)HotPeriod=0 indicates that log sinking is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| BizType | Integer | Topic type. - 0: log Topic - 1: Metric Topic Note: This field may return null, indicating that no valid values can be obtained. |
| IsWebTracking | Boolean | Free authentication switch. false: disabled; true: enabled.After enabling, anonymous access to the log topic will be supported for specified operations. For details, please refer to Log Topic (https://www.tencentcloud.com/document/product/614/41035?from_cn_redirect=1).Note: This field may return null, indicating that no valid values can be obtained. |
| Extends | TopicExtendInfo | Log topic extended information |
Index description information of the field for which key-value index needs to be enabled
Used by actions: CreateIndex, DescribeIndex, ModifyIndex.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Field type. Valid values: long, text, double |
| Tokenizer | String | No | Separator of fields. Each character represents a separator. Only symbols, \n\t\r, and escape character \ are supported. long and double fields need to be null.Note: \n\t\r can be directly enclosed in double quotes as the input parameter without escaping. When debugging with API Explorer, use the JSON parameter input method to avoid repeated escaping of \n\t\r. |
| SqlFlag | Boolean | No | Whether the analysis feature is enabled for the field |
| ContainZH | Boolean | No | Whether Chinese characters are contained. For long and double fields, set them to false.Note: This field may return null, indicating that no valid values can be obtained. |
Callback address
Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.
| Name | Type | Required | Description |
|---|---|---|---|
| Url | String | Yes | Callback address |
| CallbackType | String | Yes | Callback type. Valid values: |
| Method | String | No | Callback method. Valid values: Default value: POST. This parameter is required if CallbackType is Http.Note: This field may return null, indicating that no valid value was found. |
| Headers | Array of String | No | Request header Note: This parameter is disused. To specify request headers, see CallBack in CreateAlarmNotice.Note: This field may return null, indicating that no valid value was found. |
| Body | String | No | Request content Note: This parameter is disused. To specify request content, see CallBack in CreateAlarmNotice.Note: This field may return null, indicating that no valid value was found. |
| Index | Integer | No | Number |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback