tencent cloud

日志服务

文档日志服务API 文档Data Types

Data Types

下载
聚焦模式
字号
最后更新时间： 2026-06-10 15:54:35

AccessControlRule

DataSight Access Control Rule

Used by actions: CreateConsole, DescribeConsoles, ModifyConsole.

Name Type Required Description
CidrBlocks Array of String Yes

Network segment or IP, support IPv4 or IPv6.


Note: This field may return null, indicating that no valid values can be obtained.
Action String Yes

ACCEPT or DROP.


Note: This field may return null, indicating that no valid values can be obtained.
AccessMode String Yes

Access method: public - public network, internal - private network


Note: This field may return null, indicating that no valid values can be obtained.

AdvanceFilterRuleInfo

Advanced filtering rule.

Used by actions: CreateConfig, CreateCosRecharge, ModifyConfig, ModifyCosRecharge.

Name Type Required Description
Key String Yes Filter fields
Rule Integer Yes Filtering rule. 0: equal to; 1: the field exists; 2 the field does not exist.
Value String No Values after filtering

AdvancedConsumerConfiguration

Advanced configuration for CKafka shipping.

Used by actions: CreateConsumer, DescribeConsumers, ModifyConsumer.

Name Type Required Description
PartitionHashStatus Boolean No Kafka partition hash status. Default false.

-true: Enable sending messages with equal field Hash values to the same Kafka partition.
-false: Disable sending messages with equivalent field Hash values to the same kafka partition.
PartitionFields Array of String No Field list to calculate hash. Supports a maximum of 5 fields.

AlarmAnalysisConfig

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: execution statement 1; 2: execution statement 2.
CustomQuery: Query statement. Required and valid 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: execution statement 1; 2: execution statement 2.
CustomQuery: Query statement. Required and valid when QueryIndex is -1. Example of value: "*

AlarmClassification

Alarm Classification Information

Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

Name Type Required Description
Key String Yes Classification Key
Value String Yes Classification Value

AlarmInfo

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 for whether to trigger alarm. 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 channel groups. - Search the list of associated alarm notification channel groups via Query notification channel group list. It is mutually exclusive with MonitorNotice.
Status Boolean Enablement status
AlarmId String Alarm policy ID
CreateTime String Creation time. Format: YYYY-MM-DD HH:MM:SS
UpdateTime String Latest update time. Format: YYYY-MM-DD HH:MM:SS
MessageTemplate String Custom notification template
Note: this field may return null, indicating that no valid values can be obtained.
CallBack CallBackInfo Custom callback template
Analysis Array of AnalysisDimensional Multidimensional analysis settings
GroupTriggerStatus Boolean Group trigger status. true: enabled, false: disabled (default)
GroupTriggerCondition Array of String Grouping Trigger Conditions.
Tags Array of Tag Tag information bound to the alarm policy.
MonitorObjectType Integer Monitored object type. 0: shared monitored object for execution statements; 1: separate monitored object for each execution statement.
AlarmLevel Integer Alarm level. 0: Warn; 1: Information; 2: Critical.
Classifications Array of AlarmClassification Additional classification field for alerts.
MultiConditions Array of MultiCondition Multiple trigger conditions.
Mutually exclusive conditions.
MonitorNotice MonitorNotice Tencent Cloud observability platform channel-related information, mutually exclusive with AlarmNoticeIds

AlarmNotice

Alarm notification channel group detailed setting

Used by actions: DescribeAlarmNotices.

Name Type Description
Name String Alarm notification channel group name.
Tags Array of Tag Tag information bound to the alarm notification channel group.
Type String Alarm template type. Optional values:
  • Trigger - Alarm Trigger

  • Recovery - Alarm Recovery

  • All - Alarm Trigger and Alarm Recovery
    • NoticeReceivers Array of NoticeReceiver Alarm notification template recipient information.
    WebCallbacks Array of WebCallback Callback information of alarm notification template.
    AlarmNoticeId String Alarm notification template ID.
    NoticeRules Array of NoticeRule Notification rules.
    AlarmShieldStatus Integer Login-free operation alarm switch.
    Parameter value: 1: Turn off 2: Turn on (enabled by default)
    JumpDomain String Call link domain name. It must start with http:// or https:// and must not end with /.
    AlarmNoticeDeliverConfig AlarmNoticeDeliverConfig Shipping-related information.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time. Format: YYYY-MM-DD HH:MM:SS
    UpdateTime String Latest update time. Format: YYYY-MM-DD HH:MM:SS
    DeliverStatus Integer Delivery log switch.

    Parameter value:

    1: Disabled

    2: enable
    DeliverFlag Integer Delivery log flag.

    Parameter value:

    1: Disabled

    2: Enabled

    3: Delivery exception
    AlarmShieldCount AlarmShieldCount Alarm silence status quantity information configured for a notification channel group.
    Note: This field may return null, indicating that no valid values can be obtained.
    CallbackPrioritize Boolean Unify the setting of custom callback parameters.
    -true: Use the custom callback parameters in the notification content template to override the request header and request body separately configured in the alarm policy.
    -false: Prioritize using the request header and request body separately configured in the alarm policy.

    AlarmNoticeDeliverConfig

    Log shipping configuration information of a notification channel.

    Used by actions: DescribeAlarmNotices.

    Name Type Description
    DeliverConfig DeliverConfig Log shipping configuration information of a notification channel.
    ErrMsg String Shipping failure reason.

    AlarmShieldCount

    Alarm silence statistics.

    Used by actions: DescribeAlarmNotices.

    Name Type Description
    TotalCount Integer Total number of alarm silence policies that meet the search conditions.
    InvalidCount Integer Number of ineffective alarm silence policies.
    ValidCount Integer Number of effective alarm silence policies.
    ExpireCount Integer Number of expired alarm silence policies.

    AlarmShieldInfo

    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 Blocking rules, required when Type is 2. For detailed information on filling in rules, see Product Documentation.
    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. Unix second-level timestamp (s).
    UpdateTime Integer Rule update time. Unix second-level timestamp (s).

    AlarmTarget

    Monitoring object

    Used by actions: CreateAlarm, ModifyAlarm.

    Name Type Required Description
    TopicId String Yes Log topic ID. Obtain the log topic ID through Get Log Topic List.
    Query String Yes Query statement.
    Number Integer Yes Alarm object SN. It starts from 1 and increments.
    StartTimeOffset Integer Yes Offset of the start time of the query time range from alarm execution time, in minutes. The value cannot be positive. Maximum value: 0. Minimum value: -1,440.
    EndTimeOffset Integer Yes Offset of the end time of the query time range from alarm execution time, in minutes. The value cannot be positive and should be greater than StartTimeOffset. Maximum value: 0. Minimum value: -1440.
    LogsetId String Yes Logset ID. Obtain the logset ID through Get Log Topic List.
    SyntaxRule Integer No Search syntax rules. Default value is 0.
    0: Lucene syntax; 1: CQL syntax.
    For detailed explanation, refer to Retrieve Syntax Rules

    AlarmTargetInfo

    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.
    SyntaxRule Integer Retrieval syntax rules. Default value is 0.
    0: Lucene syntax; 1: CQL syntax.
    For detailed explanation, refer to Retrieve Syntax Rules
    BizType Integer Topic type.
    0: log topic; 1: metric topic

    AlertHistoryNotice

    Details about an alarm notification group

    Used by actions: DescribeAlertRecordHistory.

    Name Type Required Description
    Name String Yes Notification group name
    AlarmNoticeId String Yes Notification group ID

    AlertHistoryRecord

    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 Alert notification sent frequency, in minutes
    Notices Array of AlertHistoryNotice Yes Notification group
    Duration Integer Yes Duration of the alarm in minutes
    Status Integer Yes Alarm status. Valid values: 0 (uncleared), 1 (cleared), 2 (expired)
    CreateTime Integer Yes Alarm occurrence time, Unix timestamp in milliseconds (ms)
    GroupTriggerCondition Array of GroupTriggerConditionInfo No Corresponding group information when alarm grouping is triggered
    AlarmLevel Integer No Alarm level. 0: warning (Warn); 1: reminder (Info); 2: urgent (Critical).
    MonitorObjectType Integer No Monitored object type.
    0: The same object is specified for all statements. 1: An object is separately specified for each statement.
    SendType Integer No Notification channel type. 0 represents the internal notification channel of cls. 1 represents the Tencent Cloud observability platform notification channel.

    AnalysisDimensional

    Multi-Dimensional analysis dimension

    Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

    Name Type Required Description
    Name String Yes Analysis Name
    Type String Yes Analysis type: query (custom retrieval and analysis), field (TOP5 fields and proportion statistics), original (related raw logs)
    Content String Yes Analysis content
    ConfigInfo Array of AlarmAnalysisConfig No Multi-dimensional analysis configuration.

    When the Type field of Analysis is query (custom), support
    {
    "Key": "SyntaxRule", // Syntax rule
    "Value": "1" //0: Lucene syntax, 1: CQL syntax
    }

    When the Type field of Analysis is field (top5), it supports
    {
    "Key": "QueryIndex",
    "Value": "-1" // -1: Custom, 1: Execute statement 1, 2: Execute statement 2
    },{
    "Key": "CustomQuery", //Query statement. Required and valid when QueryIndex is -1.
    "Value": "*

    AnonymousInfo

    Authentication-free information.

    Used by actions: CreateTopic, ModifyTopic.

    Name Type Required Description
    Operations Array of String No Operation list. Valid values: trackLog: log upload through JS/HTTP; realtimeProducer: log upload through Kafka protocol.
    Conditions Array of ConditionInfo No List of conditions.

    AnonymousLoginInfo

    DataSight Intranet anonymous login account information

    Used by actions: CreateConsole, DescribeConsoles, ModifyConsole.

    Name Type Required Description
    SecretId String Yes

    Anonymous login account secretId


    Note: This field may return null, indicating that no valid values can be obtained.
    SecretKey String No

    Anonymous login account secretKey


    Note: This field may return null, indicating that no valid values can be obtained.

    AppointLabel

    Metadata Pod label structure.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Type Integer Yes Specify the tag type.

    -0: ALL Pod labels, invalid field Keys
    -Specify the Pod label. The Keys field cannot be empty.
    Note: This field may return null, indicating that no valid values can be obtained.
    Keys Array of String No The key of the metadata Pod tag. A valid tag key has two parts: an optional prefix and a name, separated by a slash (/). The name part is necessary and must be no more than 63 characters, starting and ending with alphanumeric characters ([a-z0-9A-Z]), with hyphens (-), underscores (_), dots (.), and alphanumerics in the middle. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), with a total length not exceeding 253 characters, followed by a slash (/).

    -Format of prefix: [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
    -name format ([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]
    -key must be unique
    Note: This field may return null, indicating that no valid values can be obtained.

    AuthRoleInfo

    Configuration information of the third-party verification login role for DataSight

    Used by actions: CreateConsole, DescribeConsoles, ModifyConsole.

    Name Type Required Description
    RoleName String Yes

    Auth role name
    SecretId String Yes

    SecretId of the permission corresponding to the Auth role
    SecretKey String No

    SecretKey of the permission corresponding to the Auth role


    Note: This field may return null, indicating that no valid values can be obtained.

    BaseMetricCollectConfig

    Metric collection configuration.

    Used by actions: DescribeClusterBaseMetricConfigs, DescribeTopicBaseMetricConfigs.

    Name Type Required Description
    GroupId String No Machine group ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    Configs Array of MetricCollectConfig No Basic monitoring collection configuration information
    Note: This field may return null, indicating that no valid values can be obtained.

    CallBackInfo

    Callback configuration

    Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

    Name Type Required Description
    Body String Yes Callback Body.
    Place various alarm variables in the request content. For details, see the help documentation (https://www.tencentcloud.com/document/product/614/74718?from_cn_redirect=1).
    in the following example:

    <br/>{<br/>"TopicId": "{{ .QueryLog[0][0].topicId }}",<br/>"key": "{{.Alarm}}",<br/>"time": "{{ .QueryLog[0][0].time }}",<br/>"log": "{{ .QueryLog[0][0].content.__CONTENT__ }}",<br/>"namespace": "{{ .QueryLog[0][0].content.__TAG__.namespace }}"<br/>}<br/>
    Headers Array of String No HTTP request header field for callbacks.
    For example, the following request header field informs the server request content type is JSON.

    <br/>"Content-Type: application/json"<br/>

    ChatUsage

    consumption

    Used by actions: ChatCompletions.

    Name Type Description
    PromptTokens Integer Number of input tokens.
    CompletionTokens Integer Number of output tokens.
    TotalTokens Integer Total number of tokens.

    Choice

    Reply, supporting multiple values

    Used by actions: ChatCompletions.

    Name Type Description
    FinishReason String

    End flag, which may be stop, sensitive, or tool_calls.
    stop means the output ends normally.
    sensitive means the security review is not passed.
    tool_calls identifies a function call.

    Note:
    Partial content may have been output, but if the FinishReason value in the middle of the response is sensitive, it means the security review is not passed. If the business scenario requires real-time text display on the screen, manually withdraw the displayed content and recommend replacing it with a custom reminder, such as "I can't answer this issue. Let's try another topic," to ensure terminal experience.
    Delta Delta

    Incremental return value. This field is used when streaming.
    Message Message

    Return value, used when Non-streaming calls.
    Index Integer

    Index value. This field is used when streaming.

    Ckafka

    Information of the CKafka instance to ship to

    Used by actions: CreateConsumer, DescribeConsumer, DescribeConsumers, ModifyConsumer.

    Name Type Required Description
    InstanceId String Yes InstanceId of Ckafka.
    - Obtain the instance id by searching the instance list information (https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).
    - Obtain the instance id by creating an instance.
    TopicName String Yes TopicName of Ckafka
    -Obtain the TopicName by creating a topic (https://www.tencentcloud.com/document/product/597/73566?from_cn_redirect=1).
    -Obtain the TopicName through Get Topic List.
    Vip String No Vip of Ckafka.
    - Obtain vip information by searching the instance attributes (https://www.tencentcloud.com/document/product/597/40836?from_cn_redirect=1).
    -If the delivery task is created via the role ARN method, the Vip field can be empty.
    Vport String No Vport of Ckafka.
    -Obtain vip port information by obtaining instance attributes.
    -If it is created by the role ARN method, the Vport field can be empty.
    InstanceName String No InstanceName of Ckafka.
    - Obtain the InstanceName by searching the instance list information (https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).
    -Get InstanceName by creating an instance.
    - If the delivery task is created via the role ARN method, the InstanceName field can be empty.
    TopicId String No Topic ID of Ckafka.
    -Obtain the TopicId by creating a topic (https://www.tencentcloud.com/document/product/597/73566?from_cn_redirect=1).
    -Obtain the TopicId through Get Topic List.
    - If the delivery task is created via the role ARN method, the TopicId field can be empty.

    CloudProductLogTaskInfo

    Cloud Product log delivery task info

    Used by actions: DescribeCloudProductLogTasks.

    Name Type Description
    ClsRegion String Service region
    InstanceId String Instance ID.
    LogsetId String Logset ID
    TopicId String Log topic ID
    Extend String Log configuration extended information, generally used for storage of additional log delivery configuration
    LogType String Log type, support enumerate: CDS-AUDIT, CDS-RISK, CDB-AUDIT, TDSQL-C-AUDIT, MongoDB-AUDIT, MongoDB-SlowLog, MongoDB-ErrorLog, TDMYSQL-SLOW, DCDB-AUDIT, DCDB-SLOW, DCDB-ERROR, MariaDB-AUDIT, MariaDB-SLOW, MariaDB-ERROR, PostgreSQL-SLOW, PostgreSQL-ERROR, PostgreSQL-AUDIT, BH-FILELOG, BH-COMMANDLOG, APIS-ACCESS
    Status Integer Task status: 0 Creating, 1 Creation completed, 2 Deleting

    Column

    Column attribute of log analysis

    Used by actions: GetAlarmLog, SearchLog.

    Name Type Description
    Name String Column name
    Type String Column attribute

    CompressInfo

    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)

    ConditionInfo

    Authentication-free conditional information.

    Used by actions: CreateTopic, ModifyTopic.

    Name Type Required Description
    Attributes String No Condition attribute. Currently, only VpcID is supported.
    Rule Integer No Conditional rule. 1: equal to; 2: not equal to.
    ConditionValue String No Value corresponding to the condition attribute.

    ConfigInfo

    Collection rule configuration information

    Used by actions: DescribeConfigs, DescribeMachineGroupConfigs.

    Name Type Description
    ConfigId String Collection rule configuration ID
    Name String Collection rule configuration name
    LogFormat String Log formatting method
    Path String log collection path
    LogType String Type of log collected.
    -json_log represents JSON file logs (see Use JSON extraction mode to collect logs).
    -delimiter_log represents: delimiter-file logs (see use delimiter extraction mode to collect logs).
    -minimalist_log represents single-line full-text file logs (see use single-line full-text extraction mode to collect logs).
    -fullregex_log represents single-line full regex-file logs (see Collect logs using single-line full regex extraction mode).
    -multiline_log represents multi-line full-text file logs (see use multi-line full-text extraction mode to collect logs).
    -multiline_fullregex_log represents: Multiline full regex-file log (see Collect logs using multiline-full regex extraction mode);
    -user_define_log represents: combined parsing mode (suitable for logs with multiple nested formats, see Collecting logs using combined parsing extraction mode);
    -service_syslog represents syslog collection (see Collect Syslog).
    - windows_event_log: Windows event log (see Collecting Windows Event Logs).
    ExtractRule ExtractRuleInfo Extraction rule. If ExtractRule is set, then LogType must be set.
    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
    -Time format: yyyy-MM-dd HH:mm:ss
    CreateTime Timestamp Creation time.
    -Time format: yyyy-MM-dd HH:mm:ss
    UserDefineRule String Custom parsing string. For more information, see Collecting logs using combined parsing extraction mode.
    AdvancedConfig String Advanced collection configuration. Json string, Key/Value is defined as follows:
    -ClsAgentFileTimeout (timeout attribute). Value ranges from 0 to integer. 0 means no timeout.
    -ClsAgentMaxDepth (maximum directory depth), value ranges from 0 to integer
    -ClsAgentParseFailMerge (merge parsing failure logs). Value ranges from true to false.
    Example:
    {\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}

    Default placeholder value in console: {\"ClsAgentDefault\":0}
    InputType String Log input type (Note: required for Windows scenario and only supports file and windows_event event type)
    -file type collection
    -windows event collection
    -syslog: System log collection

    Console

    DataSight Console instance

    Used by actions: DescribeConsoles.

    Name Type Description
    ConsoleId String

    DataSight Console Id
    AccessMode Array of String

    Access method: public - internet, internal - intranet
    LoginMode Integer

    Log-in methods: 0-account password authentication, 1-anonymous login, 2-third-party authentication login
    DomainPrefix String

    Custom domain name prefix
    Accounts Array of ConsoleAccount

    User account information


    Note: This field may return null, indicating that no valid values can be obtained.
    IntranetType Integer

    Private network type, defaults to 0


    Note: This field may return null, indicating that no valid values can be obtained.
    IntranetRegion String

    Private network region


    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String

    Private network VpcId


    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String

    Private subnet SubnetId


    Note: This field may return null, indicating that no valid values can be obtained.
    AnonymousLogin AnonymousLoginInfo

    Anonymous login account information


    Note: This field may return null, indicating that no valid values can be obtained.
    AuthRoles Array of AuthRoleInfo

    auth user role information


    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag

    Bound tag information


    Note: This field may return null, indicating that no valid values can be obtained.
    HideParams Array of String

    Custom hidden parameter


    Note: This field may return null, indicating that no valid values can be obtained.
    AccessControlRules Array of AccessControlRule

    Access Control Rule


    Note: This field may return null, indicating that no valid values can be obtained.
    Remarks String

    Remark


    Note: This field may return null, indicating that no valid values can be obtained.
    Menus Array of String

    Customize menu


    Note: This field may return null, indicating that no valid values can be obtained.
    Domain String

    Public access domain name
    IntranetDomain String

    private network access domain

    ConsoleAccount

    DataSight Console user account information

    Used by actions: CreateConsole, DescribeConsoles, ModifyConsole.

    Name Type Required Description
    UserName String Yes

    Username.


    Note: This field may return null, indicating that no valid values can be obtained.
    Password String Yes

    User password


    Note: This field may return null, indicating that no valid values can be obtained.
    SecretId String Yes

    Tencent Cloud account SecretId


    Note: This field may return null, indicating that no valid values can be obtained.
    SecretKey String Yes

    Tencent Cloud Account SecretKey


    Note: This field may return null, indicating that no valid values can be obtained.
    Email String No

    Electronic mailbox for sending verification code


    Note: This field may return null, indicating that no valid values can be obtained.

    ConsumerContent

    Shipping content

    Used by actions: CreateConsumer, DescribeConsumer, DescribeConsumers, ModifyConsumer.

    Name Type Required Description
    EnableTag Boolean Yes

    Whether to deliver TAG information.
    When EnableTag is true, it means to deliver TAG metadata.
    MetaFields Array of String Yes

    List of metadata to be shipped, currently only support: SOURCE, FILENAME, TIMESTAMP, HOSTNAME, and PKGID
    TagJsonNotTiled Boolean No

    When EnableTag is true, the TagJsonNotTiled field must be filled.
    TagJsonNotTiled indicates whether tag information is json tiled.

    When TagJsonNotTiled is true, it is not tiled. Example:
    tag information: {"__tag__":{"fieldA":200,"fieldB":"text"}}
    Not Tiled: {"__tag__":{"fieldA":200,"fieldB":"text"}}

    When TagJsonNotTiled is false, tiling is applied. Example:
    tag information: {"__tag__":{"fieldA":200,"fieldB":"text"}}
    Tiled: {"__tag__.fieldA":200,"__tag__.fieldB":"text"}
    TimestampAccuracy Integer No

    Delivery timestamp precision, options [1: second; 2: millisecond], 1 is selected by default.
    JsonType Integer No

    Deliver in Json format.

    Enumeration value:

    • 0: Escape. Example:
      Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}
      Deliver to Ckafka: {"a":"aa","b":"{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}"}
    • 1: Consistent with original log, non-escaping. Example:
      Original log: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}
      Deliver to Ckafka: {"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}

    ConsumerGroup

    Consumption group information over kafka protocol

    Used by actions: DescribeKafkaConsumerGroupList.

    Name Type Description
    Group String Consumer group name
    State String Status.

    -Empty: The group has no members but has submitted offsets. All consumers left but retained offsets.
    -Dead: The group has no members and no submitted offsets. The group is deleted or has long-term inactivity.
    -Stable: Members in the group consume normally with balanced partition allocation. Normal operating status.
    -PreparingRebalance: The group is preparing to rebalance. New members join or existing members leave.
    -CompletingRebalance: The group is preparing to rebalance. New members join or existing members leave.
    ProtocolName String Partition allocation policy balancing algorithm name.

    -Common load balancing algorithms are as follows:
    -range: Allocate by partition range
    -roundrobin: Poll-based allocation
    -sticky: Sticky assignment (avoid unnecessary rebalance)

    ConsumerGroupInfo

    Consumer group information

    Used by actions: DescribeConsumerGroups.

    Name Type Description
    ConsumerGroup String Consumer group flag.
    Timeout Integer Consumer heartbeat timeout (seconds).
    Topics Array of String topic list

    ConsumerInfo

    Shipping Rule

    Used by actions: DescribeConsumers.

    Name Type Description
    ConsumerId String Shipping rule ID
    TopicId String Log topic ID
    Effective Boolean Whether the shipping task is effective.
    Ckafka Ckafka Description of CKafka
    NeedContent Boolean Whether to ship the log's metadata information
    Content ConsumerContent Description of the metadata information to be shipped
    Note: This field may return null, indicating that no valid values can be obtained.
    Compression Integer Compression mode [0:NONE；2:SNAPPY；3:LZ4]
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time of a shipping task (a millisecond-level timestamp).
    Note: This field may return null, indicating that no valid values can be obtained.
    RoleArn String ARN (Access Role Name) Create role
    Note: This field may return null, indicating that no valid values can be obtained.
    ExternalId String External ID
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskStatus Integer Task running status. Valid values: 0: stopped; 1: running; 2: abnormal.
    Note: This field may return null, indicating that no valid values can be obtained.
    AdvancedConfig AdvancedConsumerConfiguration Advanced configuration

    ContentInfo

    Format configuration of shipped log content

    Used by actions: CreateShipper, DescribeShippers, ModifyShipper.

    Name Type Required Description
    Format String Yes Content format, support json, csv, parquet
    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 description
    Note: This field may return null, indicating that no valid value can be obtained.

    CosRechargeInfo

    COS import configuration information.

    Used by actions: DescribeCosRecharges.

    Name Type Description
    Id String COS import configuration ID.
    TopicId String Log topic ID
    LogsetId String Logset ID
    Name String COS import task name
    Bucket String COS bucket
    BucketRegion String COS bucket location.

    -Obtain region information via regions and access endpoints.
    Prefix String Prefix of the COS file folder location
    LogType String Types of logs collected: json_log represents JSON logs, delimiter_log represents delimiter-separated format logs, minimalist_log represents single-line full-text representation.
    default is minimalist_log
    Status Integer status 0: Created, 1: Running, 2: Stopped, 3: Completed, 4: Execution failed.
    Enable Integer Whether this feature is enabled. 0: Disabled; 1: Enabled.
    CreateTime String Creation time. Time format: YYYY-MM-DD HH:mm:ss
    UpdateTime String Update time. Time format: YYYY-MM-DD HH:mm:ss
    Progress Integer Progress Bar Percentage
    Compress String Compression methods supported: "", "gzip", "lzop", and "snappy". Default empty with no compression.
    ExtractRuleInfo ExtractRuleInfo See the description of the ExtractRuleInfo structure.
    TaskType Integer COS import task type. Valid values: 1: one-time import task; 2: continuous import task.
    Metadata Array of String Metadata. Buckets and objects are supported.

    CsvInfo

    CSV content description

    Used by actions: CreateShipper, 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

    CustomLabel

    Custom label structure.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Key String Yes Tag key.
    -Must start with a letter or underscore, but cannot start with double underscores (__), followed by any letter, digit, or underscore.
    - Supports up to 256 characters.
    -key must be unique
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Yes Tag value.
    - Supports up to 256 characters.
    Note: This field may return null, indicating that no valid values can be obtained.

    CustomMetricSpec

    Custom metric collection object.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Port String Yes Port. Value range: [1,65535].
    Note: This field may return null, indicating that no valid values can be obtained.
    Path String Yes Metric address. Verification format: ^/[a-zA-Z0-9-_./]*$.
    Note: This field may return null, indicating that no valid values can be obtained.
    Namespaces Array of String No Namespace list.
    -Supports up to 100.
    -Check format of namespace [a-z0-9]([-a-z0-9]*[a-z0-9])?. Length cannot exceed 63.
    -namespace must be unique
    Note: This field may return null, indicating that no valid values can be obtained.
    PodLabel Array of Label No Pod tag.
    -supports a maximum of 100

    Note: This field may return null, indicating that no valid values can be obtained.

    DashboardNoticeMode

    Dashboard subscription notification method

    Used by actions: CreateDashboardSubscribe, ModifyDashboardSubscribe, SearchDashboardSubscribe.

    Name Type Required Description
    ReceiverType String Yes Dashboard notification method.

    -Uin: Tencent Cloud user
    -Group: Tencent Cloud user group
    -WeCom: wecom callback
    -Email: Custom email
    -DingTalk
    -Lark
    Values Array of String No Value of the known method.
    -When ReceiverType is WeCom, DingTalk, or Lark, Values must be empty and the Url field is required.
    -When ReceiverType is Uin, Group, or Email, the Values field is required and the Url field must be empty.
    -When ReceiverType is Uin, Values is the user id. Obtain the sub-user UID by querying sub-users.
    -When ReceiverType is Group, Values is the user Group id. Obtain user Group id by querying the user Group list (https://www.tencentcloud.com/document/product/598/34589?from_cn_redirect=1).
    -When ReceiverType is Email, Values is the user email info.
    ReceiverChannels Array of String No Dashboard notification channel.

    -Support: ["Email","Sms","WeChat","Phone"].
    -When ReceiverType is Email or WeCom, ReceiverChannels is invalid.
    Note: This field may return null, indicating that no valid values can be obtained.
    Url String No Subscription method - Callback URL.
    -When ReceiverType is WeCom, DingTalk, or Lark, the Url field is required as the callback URL of each channel.
    -When the value is WeCom, the Url is the enterprise wechat callback address.
    -When the value is DingTalk, Url is the chatbot Webhook address.
    -When Lark, Url is the chatbot Webhook address.
    -When ReceiverType is Uin, Group, or Email, the Url field must be empty.

    DashboardSubscribeData

    Dashboard subscription data

    Used by actions: CreateDashboardSubscribe, DescribeDashboardSubscribes, ModifyDashboardSubscribe, SearchDashboardSubscribe.

    Name Type Required Description
    NoticeModes Array of DashboardNoticeMode Yes Dashboard subscription notification method.
    DashboardTime Array of String No Dashboard subscription time. If this field is empty, the dashboard default time is used.
    Note: This field may return null, indicating that no valid values can be obtained.
    TemplateVariables Array of DashboardTemplateVariable No Dashboard subscription template variable.
    Note: This field may return null, indicating that no valid values can be obtained.
    Timezone String No Time zone. Refer to: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI.
    SubscribeLanguage String No Language. zh: Chinese; en: English.
    JumpDomain String No Call link domain name. It must start with http:// or https:// and must not end with /.
    JumpUrl String No Custom redirection link.

    DashboardSubscribeInfo

    Dashboard subscription information

    Used by actions: DescribeDashboardSubscribes.

    Name Type Description
    Id Integer Dashboard subscription ID
    Name String Dashboard subscription name.
    DashboardId String Dashboard ID.
    Cron String Dashboard subscription time.
    SubscribeData DashboardSubscribeData Dashboard subscription data.
    CreateTime String Creation time of dashboard subscription record. Format: YYYY-MM-DD HH:MM:SS
    UpdateTime String Dashboard subscription record update time. Format: YYYY-MM-DD HH:MM:SS
    LastTime String Time sent successfully of dashboard subscription record. Format: YYYY-MM-DD HH:MM:SS
    Uin Integer Cloud primary account ID.
    SubUin Integer Sub-account ID under coud main account.
    LastStatus String Last sending status of the dashboard subscription records. success: all sent successfully; fail: not sent; partialSuccess: partially sent successfully.

    DashboardTemplateVariable

    Dashboard subscription template variable

    Used by actions: CreateDashboardSubscribe, ModifyDashboardSubscribe, SearchDashboardSubscribe.

    Name Type Required Description
    Key String Yes Key value
    Values Array of String Yes Corresponding values of the key

    DataTransformResouceInfo

    Information about the resource for data processing

    Used by actions: CheckFunction, CreateDataTransform, DescribeDataTransformInfo, ModifyDataTransform.

    Name Type Required Description
    TopicId String Yes

    Log topic ID
    Alias String No

    Alias
    Limitation: Cannot contain character
    IsCrossAccount Boolean No

    Whether it is a cross-account topic. false means it is not a cross-account topic, and true means it is a cross-account topic.

    Default value: false
    RoleARN String No

    In a cross-account scenario, search for the role ARN value created by the delivery account for the shipping account in the roles of the shipping account.
    ExternalId String No

    External ID value. Can be found in the role-carrier of the shipping account.
    TopicName String No

    topic name
    LogsetName String No

    Logset name

    DataTransformSqlDataSource

    SQL information of external tables

    Used by actions: CreateDataTransform, DescribeDataTransformInfo, ModifyDataTransform.

    Name Type Required Description
    DataSource Integer Yes Data source type 1: MySql; 2: Self-built MySql; 3: PostgreSQL
    Region String Yes Region of the InstanceId. For example: ap-guangzhou
    InstanceId String Yes Instance ID.
    -When DataSource is 1, it means the id of a cloud database Mysql Instance, such as cdb-zxcvbnm.
    User String Yes mysql access username
    AliasName String Yes Alias. For use in data processing statement.
    Password String No mysql access password.

    DataTransformTaskInfo

    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 Processing task type, 1: DSL (processing task using custom language), 2: SQL (processing task using 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 Creation time.
    Time format: yyyy-MM-dd HH:mm:ss
    UpdateTime String Last modification time
    Time format: yyyy-MM-dd HH:mm:ss
    LastEnableTime String Last enabled time. Modify this time if the cluster needs to be rebuilt.
    Time format: yyyy-MM-dd HH:mm:ss
    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 Processing logic function.
    BackupTopicID String Fallback Topic ID
    BackupGiveUpData Boolean Whether to discard log data after the limit is exceeded
    HasServicesLog Integer Whether to enable service log shipping. Valid values: 1: disable; 2: enable.
    TaskDstCount Integer Number of the target log topics of a task.
    DataTransformType Integer Data processing type. Valid values: 0: standard processing task; 1: pre-processing task.
    KeepFailureLog Integer Whether to keep the failure log status. Valid values: 1: no; 2: yes.
    FailureLogKey String Field name of a failed log.
    ProcessFromTimestamp Integer Specify the start time of data processing (a second-level timestamp).
    -For any time range within the log topic lifecycle, if it exceeds the lifecycle, only process the part with data within the lifecycle.
    ProcessToTimestamp Integer Specify the end time of data processing, a Unix second-level timestamp.
    1. Cannot specify a future time
    2. If left blank, it means that the task will run constantly.
    DataTransformSqlDataSources Array of DataTransformSqlDataSource sql data source information
    EnvInfos Array of EnvInfo Environment variable.

    DeliverConfig

    Shipping configuration input parameter.

    Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.

    Name Type Required Description
    Region String Yes Region information.

    Example
    ap-guangzhou: Guangzhou region.
    ap-nanjing Nanjing region.

    For detailed information, see regions and access endpoints on the official website.
    TopicId String Yes Log topic ID. Obtain the log topic ID through Get Log Topic List.
    Scope Integer Yes Data delivery scope.

    All logs, including daily logs generated by periodic execution of alarm policies and logs generated by policy changes. Default value.

    1: Alarm triggering only and restore log

    Delta

    Returned content.

    Used by actions: ChatCompletions.

    Name Type Required Description
    Role String No

    Role

    Enumeration value:

    • user: User
    • assistant: AI assistant
    Content String No

    Content details
    ReasoningContent String No

    Thought chain content.
    Used to show the model thinking process, only available in deep thinking mode. Returned as an output parameter only, no need to input it in multi-round dialogue.
    ToolCalls Array of ToolCall No

    Tool call generated by the model. Only support output parameter return.
    For each output value, merge the Type, Name, and Arguments fields with Id as the flag.

    Dimension

    Dimension information of a cloud product instance.

    Used by actions: DescribeMetricSubscribePreview.

    Name Type Description
    Name String Instance dimension name. This field may return null, indicating that no valid values can be obtained.
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Instance dimension value. This field may return null, indicating that no valid values can be obtained.
    Note: This field may return null, indicating that no valid values can be obtained.

    DlcDeliverInfo

    Submit DLC task configuration

    Used by actions: DescribeDlcDelivers.

    Name Type Description
    TaskId String Task ID.
    Uin Integer Account id.
    TopicId String Log topic ID.
    Name String Task name.
    DeliverType Integer Delivery Type. Valid values: 0: real-time delivery; 1: historic delivery.
    MaxSize Integer Delivery file size in MB
    Interval Integer Delivery interval in seconds
    StartTime Integer Start time of the delivery time range
    EndTime Integer End time of the delivery time range
    DlcInfo DlcInfo dlc configuration message
    HasServicesLog Integer Whether to enable delivery service log. 1 for disabled, 2 for enabled
    Status Integer Task status.
    Progress Integer Task progress. Historic delivery tasks take effect.
    BizType Integer Topic type of logs. 0: standard topic; 1: metric topic.
    CreateTime Integer Task creation time.
    UpdateTime Integer Task modification time.

    DlcFiledInfo

    Data Lake Computing Service (Data Lake Compute, DLC) data field configuration message

    Used by actions: CreateDlcDeliver, ModifyDlcDeliver.

    Name Type Required Description
    ClsField String Yes

    Field name in the cls log
    DlcField String Yes

    Column name of the data lake computing service table
    DlcFieldType String Yes

    Data lake computing service field Type

    Enumeration value:

    • int
    FillField String No

    Parsing failure padding field
    Disable Boolean No

    Whether to disable

    DlcInfo

    Data Lake Computing Service (Data Lake Compute, DLC) import configuration info

    Used by actions: CreateDlcDeliver, DescribeDlcDelivers, ModifyDlcDeliver.

    Name Type Required Description
    TableInfo DlcTableInfo Yes dlc table information
    FieldInfos Array of DlcFiledInfo Yes dlc data field information
    PartitionInfos Array of DlcPartitionInfo Yes dlc partition information
    PartitionExtra DlcPartitionExtra No dlc partition additional information

    DlcPartitionExtra

    Data Lake Computing Service (Data Lake Compute, abbreviation DLC) partitioning additional information

    Used by actions: CreateDlcDeliver, ModifyDlcDeliver.

    Name Type Required Description
    TimeFormat String No Time format, e.g.: %Y-%m-%d %H:%m:%S.%f
    TimeZone String No Time zone

    DlcPartitionInfo

    Data Lake Computing Service (Data Lake Compute, abbreviation DLC) partitioning configuration

    Used by actions: CreateDlcDeliver, ModifyDlcDeliver.

    Name Type Required Description
    ClsField String Yes

    Field names in cls logs
    DlcField String Yes

    Column name of the dlc table
    DlcFieldType String Yes

    Refer to Type definition in DLC Column

    Enumeration value:

    • int

    DlcTableInfo

    Data Lake Computing Service (Data Lake Compute, DLC) data table configuration info

    Used by actions: CreateDlcDeliver, ModifyDlcDeliver.

    Name Type Required Description
    DataDirectory String Yes Data catalog
    DatabaseName String Yes Database.
    TableName String Yes data table

    DynamicIndex

    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 Automatic configuration switch of the key-value index.

    EnvInfo

    Data Processing - Advanced Setting - Environment Variable

    Used by actions: CreateDataTransform, DescribeDataTransformInfo, ModifyDataTransform.

    Name Type Required Description
    Key String Yes Environment variable name
    Value String No Environment variable value

    EsImportInfo

    Import Es information

    Used by actions: CreateEsRecharge, DescribeEsRechargePreview, DescribeEsRecharges, ModifyEsRecharge.

    Name Type Required Description
    Type Integer Yes Import mode.
    1. Import history data
    2. Import real-time data
    StartTime Integer No Start time. Unit: unix second-level timestamp.
    EndTime Integer No End time. Unit: unix second-level timestamp.
    MaxDelay Integer No Maximum delay time. Unit: s

    Import mode is 2. Required for importing real-time data.
    CheckInterval Integer No Check interval. Unit: s

    Import mode is 2. Required for importing real-time data.

    EsInfo

    es cluster configuration

    Used by actions: CreateEsRecharge, DescribeEsRechargePreview, DescribeEsRecharges, ModifyEsRecharge.

    Name Type Required Description
    EsType Integer Yes ES Types. 1: Cloud ES, 2: Self-build ES.
    AccessMode Integer No Access method 1: private network, 2: public network. Self-built ES required.
    InstanceId String No Instance id. Required for es instance.
    User String No Username.
    Address String No Access address. Self-built ES required.
    Port Integer No Access port. Self-built ES required.
    VpcId String No Network. Required when accessing self-built ES via private network.
    VirtualGatewayType Integer No Network service type. Required when accessing a self-built ES via private network.
    CLB:1025 Cloud Virtual Machine (CVM):0
    Password String No Password.

    EsRechargeInfo

    Import es configuration info

    Used by actions: DescribeEsRecharges.

    Name Type Description
    TaskId String Task ID.
    Uin Integer Main account id.
    TopicId String Log topic ID.
    -Obtain the log topic Id through Get Log Topic List.
    - Obtain the log topic Id through Create Log Topic.
    Name String Configuration name
    Index String es index.
    Query String Elasticsearch Query Statement.
    EsInfo EsInfo es cluster information.
    ImportInfo EsImportInfo es import information.
    TimeInfo EsTimeInfo ES import time configuration message.
    Status Integer Task status.
    1. Running
    Suspend
    3. Complete
    4. Exception
    Progress Integer Task progress 0-100 percentage. 100: means done.
    SubUin Integer Sub-account id.
    CreateTime Integer Creation time.
    UpdateTime Integer Modify the time.
    HasServicesLog Integer Whether to enable service log shipping. Valid values: 1: disable; 2: enable.

    EsTimeInfo

    Import time field information for Es

    Used by actions: CreateEsRecharge, DescribeEsRechargePreview, DescribeEsRecharges, ModifyEsRecharge.

    Name Type Required Description
    Type Integer Yes Time type 1: Log collection time 2: Specify log fields
    TimeKey String No Log time field.

    Time type is 2: Required when specifying log fields
    TimeFormat String No Log time format.

    Time type is 2: Required when specifying log fields
    TimeZone String No Time field time zone.

    Time type is 2: Required when specifying log fields

    EscalateNoticeInfo

    Upgrade notification.

    Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.

    Name Type Required Description
    NoticeReceivers Array of NoticeReceiver Yes Alarm notification template recipient information.
    WebCallbacks Array of WebCallback Yes Callback information of alarm notification template.
    Escalate Boolean No Alarm escalation switch. true: enable alarm escalation, false: disable alarm escalation. Default: false.
    Interval Integer No Escalate alarms interval. Unit: minutes, range [1, 14400].
    Type Integer No Upgrade conditions. 1: Unclaimed and unrecovered, 2: Unrecovered, defaults to 1.
    -Unclaimed and unrecovered: Upgrade if the alert is not restored and no one claims it.
    -Unrecovered: Upgrade if the alarm persists without recovery.
    EscalateNotice EscalateNoticeInfo No Notification channel configuration for the next step after alarm severity escalation. A maximum of five steps can be configured.

    EventLog

    Windows event log collection configuration

    Used by actions: CreateConfig, CreateCosRecharge, ModifyConfig, ModifyCosRecharge.

    Name Type Required Description
    EventChannel String Yes Event channel, support
    -Application log
    -Security log
    -Startup log
    -System log
    -ALL logs
    TimeType Integer Yes Supported types of the time field (Timestamp)
    -1 (User-customized time)
    -2 (current time)
    Timestamp Integer No Time, when users choose custom time type, specify the time in seconds
    Format: timestamp, 1754897446
    EventIDs Array of String No Event ID filter list

    Optional. Being empty indicates no filtering is applied.
    Support forward filtering for a single value (for example: 20) or a range (for example: 0-20), also support reverse filtering for a single value (for example: -20).
    Multiple filter items can be separated by commas, for example: 1-200,-100 means collect event logs within the range of 1-200 except 100.

    ExcludePathInfo

    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

    ExportInfo

    Log export information

    Used by actions: DescribeExports.

    Name Type Description
    TopicId String

    Log topic ID.
    ExportId String

    Log export task ID
    Query String

    Query statements of log export
    FileName String

    Filenames of exported logs
    FileSize Integer

    Log file size

    Unit: Byte
    Order String

    Sorting of log export time
    Format String

    Log export format
    Count Integer

    Number of logs to be exported
    Status String

    Log download status. Processing: export in progress, Completed: export completed, Failed: export failure, Expired: log export expired (valid for 3 days), Queuing: queuing
    From Integer

    Start time of log export, with a timestamp in milliseconds
    To Integer

    End time of log export, timestamp in milliseconds
    CosPath String

    Log export path, valid for one hour. Please download using this path as soon as possible.
    CreateTime String

    Log export creation time
    Date and Time Formats: yyyy-MM-dd HH:mm:ss
    SyntaxRule Integer

    Syntax rule. Default value is 0.
    0: Lucene syntax, 1: CQL syntax.
    DerivedFields Array of String

    Export fields

    ExternalRole

    Cross-account delivery of external roles

    Used by actions: CreateSplunkDeliver, DescribeSplunkDelivers, ModifySplunkDeliver.

    Name Type Required Description
    RoleArn String Yes

    Cross-account delivery - User role RoleArn
    ExternalId String Yes

    Cross-account delivery - User role name

    ExtractRuleInfo

    Log extraction rule

    Used by actions: CreateConfig, CreateCosRecharge, DescribeConfigs, DescribeCosRecharges, DescribeMachineGroupConfigs, ModifyConfig, ModifyCosRecharge.

    Name Type Required Description
    TimeKey String No

    key name for the time field. TimeKey and TimeFormat must appear in pairs
    TimeFormat String No

    Time field format. Refer to the strftime function in C language for time format description output parameter
    Delimiter String No

    Delimiter for log type. Only valid when LogType is delimiter_log
    LogRegex String No

    The whole log matching rule is only valid when LogType is fullregex_log
    BeginRegex String No

    First-line matching rule. Valid only when LogType is multiline_log or fullregex_log.
    Keys Array of String No

    The key name of each field. An empty key means to discard the field. Valid only when LogType is delimiter_log. For json_log, use the key in the 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 filtering rule list (legacy version), keys to be filtered, and corresponding regex.
    Note: For LogListener 2.9.3 and above versions, it is recommended to use log filtering rules configuration.
    UnMatchUpLoadSwitch Boolean No

    Whether to upload logs that failed to be parsed, true for upload, false for not uploading


    Note: This field may return null, indicating that no valid values can be obtained.
    UnMatchLogKey String No

    key of the failure log, required when UnMatchUpLoadSwitch is true


    Note: This field may return null, indicating that no valid values can be obtained.
    Backtracking Integer No

    Backtracking data volume in incremental collection mode. Default: -1 (full collection). Other non-negative numbers indicate incremental collection (backward collection of ${Backtracking} Byte logs from the newest position). Supports up to 1073741824 (1G).
    Note:

    • COS import does not support this field.

    Note: This field may return null, indicating that no valid values can be obtained.
    IsGBK Integer No

    Whether it is Gbk encoding. 0: No; 1: Yes.
    Note

    • Currently, a value of 0 indicates UTF-8 encoding.
    • COS import does not support this field.
    JsonStandard Integer No

    Whether it is standard json. 0: No; 1: Yes.

    • Standard json means the collector uses industry-standard open-source parsers for json parsing. Non-standard json means the collector uses CLS self-developed json parsers. There is no essential difference between the two parsers. We recommend customers use standard json for parsing.

    Note: This field may return null, indicating that no valid values can be obtained.
    Protocol String No

    syslog transport protocol, valid values: tcp, udp, this parameter is valid only when LogType is service_syslog, not required for other types.
    Note:

    • This field applies to: create collection rule configuration, modify collection rule configuration.
    • COS import does not support this field.
    Address String No

    syslog system log collection specifies the address and port listened to by the collector, format: [ip]:[port]. This parameter is valid only when LogType is service_syslog. No need to specify for other types.
    Note:

    • This field applies to: create collection rule configuration, modify collection rule configuration.
    • COS import does not support this field.
    ParseProtocol String No

    rfc3164: Specify system log collection using RFC3164 protocol parsing.
    rfc5424: Specify system log collection using RFC5424 protocol parsing.
    auto: Automatically match either RFC3164 or RFC5424 protocol.
    This parameter is valid only when LogType is service_syslog. Not required for other types.
    Note:

    • This field is applicable to: create collection rule configuration, modify collection rule configuration.
    • COS import does not support this field.
    MetadataType Integer No

    Metadata type. 0: Not use metadata information; 1: Use machine group metadata; 2: Using custom metadata; 3: Use collection configuration path.
    Note:

    • COS import does not support this field.
    PathRegex String No

    Collection configuration path regular expression.

    Use "()" to identify the regular expression corresponding to the target field in the path. During parsing, "()" is considered as a capture group and reported together with logs in the form of __TAG__.{i}:{target field name}, where i is the serial number of the capture group. If you do not want to use the serial number as the key name, you can define a custom key name through the named capturing group "(?<{key name}>{regular expression})" and report it together with logs in the form of __TAG__.{key name}:{target field name}. Supports up to 5 capture groups.

    Note:

    • Required when MetadataType is 3.
    • This field is not supported in COS import.
    MetaTags Array of MetaTagInfo No

    User-defined metadata information.
    Note:

    • Required when MetadataType is 2.
    • This field is not supported for COS import.
    EventLogRules Array of EventLog No

    The Windows Event Log Collection rule is valid only when LogType is windows_event_log. No need to specify for other types.
    AdvanceFilterRules Array of AdvanceFilterRuleInfo No

    Log filtering rule list (new version).
    Note:

    • LogListener versions below 2.9.3 do not support this. Please use FilterKeyRegex to configure log filter rules.
    • Self-built k8s collection configuration (CreateConfigExtra, ModifyConfigExtra) does not support this field.

    Note: This field may return null, indicating that no valid values can be obtained.
    RawLogKey String No

    Key name of raw logs. All raw logs are uploaded with the Key name you specified, and the original log content as Value. If left empty, raw log upload is disabled.

    • COS import does not support this field.

    Filter

    Filter

    Used by actions: DescribeAlarmNotices, DescribeAlarmShields, DescribeAlarms, DescribeAlertRecordHistory, DescribeCloudProductLogTasks, DescribeClusterBaseMetricConfigs, DescribeClusterMetricConfigs, DescribeConfigs, DescribeConsoles, DescribeConsumers, DescribeDashboardSubscribes, DescribeDataTransformInfo, DescribeDlcDelivers, DescribeEsRecharges, DescribeHostMetricConfigs, DescribeKafkaConsumerGroupList, DescribeLogsets, DescribeMachineGroups, DescribeMachines, DescribeMetricSubscribes, DescribeNetworkApplications, DescribeNoticeContents, DescribeRecordingRuleTask, DescribeRecordingRuleYamlTask, DescribeScheduledSqlInfo, DescribeSearchViews, DescribeShippers, DescribeSplunkDelivers, DescribeTopicBaseMetricConfigs, DescribeTopicMetricConfigs, DescribeTopics, DescribeWebCallbacks.

    Name Type Required Description
    Key String Yes Field to be filtered
    Values Array of String Yes Value to be filtered

    FilterRuleInfo

    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

    FilterStatistics

    Task data filtering statistical information for delivery

    Used by actions: DescribeSplunkPreview.

    Name Type Description
    OriginalCount Integer

    Number of raw logs
    FilteredCount Integer

    Number of filtered logs
    FilteredResult Array of String

    Filtered results

    FullTextInfo

    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

    GroupPartitionInfo

    Consumption group distinguish information over kafka protocol

    Used by actions: DescribeKafkaConsumerGroupDetail.

    Name Type Description
    PartitionId Integer Partition ID
    CommitTimestamp Integer Latest data timestamp of the partition, unit: s
    Consumer String consumer

    GroupTriggerConditionInfo

    Condition of triggering by group

    Used by actions: DescribeAlertRecordHistory.

    Name Type Required Description
    Key String Yes Name of the field for triggering by group
    Value String Yes Value of the field for triggering by group

    HighLightItem

    Keywords that meet search criteria are generally highlighted. Only key-value search is supported, not full-text search.

    Used by actions: DescribeLogContext, GetAlarmLog, SearchLog.

    Name Type Description
    Key String Highlighted log field name.
    Values Array of String Highlighted keywords.

    HistogramInfo

    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

    HostMetricConfig

    Host metrics collection configuration

    Used by actions: DescribeHostMetricConfigs.

    Name Type Description
    ConfigId String Collection Configuration id
    Name String Collection configuration name
    Interval Integer Collection frequency, in milliseconds
    HostMetricItems Array of HostMetricItem Collection item
    MachineGroupIds Array of String Machine group id list
    CreateTime Integer Creation time.
    UpdateTime Integer Modification time.

    HostMetricItem

    Host metrics collection item

    Used by actions: CreateHostMetricConfig, DescribeHostMetricConfigs, ModifyHostMetricConfig.

    Name Type Required Description
    Type String Yes Host metric collection item type. Supports "cpu", "mem", "net", "disk", "system".

    - cpu:CPU
    -mem: memory
    -net: network
    -disk
    - system: System

    Instance

    Instance information

    Used by actions: CreateMetricSubscribe, DescribeMetricSubscribePreview, DescribeMetricSubscribes, ModifyMetricSubscribe.

    Name Type Required Description
    Values Array of String Yes Instance information

    InstanceConfig

    Instance configuration information

    Used by actions: CreateMetricSubscribe, DescribeMetricSubscribePreview, DescribeMetricSubscribes, ModifyMetricSubscribe.

    Name Type Required Description
    InstanceDimension Array of String Yes instance dimension
    Instances Array of Instance Yes Instance value

    InstanceData

    Instance information in cloud product metric subscription preview results.

    Used by actions: DescribeMetricSubscribePreview.

    Name Type Description
    MetricName String Cloud Monitor metric name.
    Note: This field may return null, indicating that no valid values can be obtained.
    CLSMetricName String CLS metric name.
    Note: This field may return null, indicating that no valid values can be obtained.
    Namespace String Cloud product namespace.
    Note: This field may return null, indicating that no valid values can be obtained.
    Dimensions Array of Dimension Instance information
    Note: This field may return null, indicating that no valid values can be obtained.
    Period Integer Period (seconds).
    Note: This field may return null, indicating that no valid values can be obtained.
    Value Float Statistical value of a metric.
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrMsg String Error message
    Note: This field may return null, indicating that no valid values can be obtained.

    JsonInfo

    JSON type description

    Used by actions: CreateShipper, ModifyShipper.

    Name Type Required Description
    EnableTag Boolean Yes Enablement flag
    MetaFields Array of String Yes Metadata information list, available values are SOURCE, FILENAME, TIMESTAMP, HOSTNAME.

    -SOURCE IP for log collection, for example: 10.0.1.2
    -FILENAME: Log collection file name, for example: /data/log/nginx/access.log
    -TIMESTAMP: Log timestamp (millisecond-level Unix timestamp). When retrieving logs by time range, the time is automatically used to retrieve logs. It is displayed on the console as "log time", for example: 1640005601188.
    -HOSTNAME: Log source machine name. Need to use Loglistener 2.7.4 and above versions to capture this field, for example: localhost.
    Note: This field may return null, indicating that no valid values can be obtained.
    JsonType Integer No JSON format for shipping. 0: shipped as a string; 1: shipped in a structured way.

    KafkaConsumerContent

    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 method: 1: Not Tiled (default value); 2: Tile.

    Untiled example:
    TAG information: {"__TAG__":{"fieldA":200,"fieldB":"text"}}
    No tiling: {"__TAG__":{"fieldA":200,"fieldB":"text"}}

    Tiled example:
    TAG information: {"__TAG__":{"fieldA":200,"fieldB":"text"}}
    Tiled: {"__TAG__.fieldA":200,"__TAG__.fieldB":"text"}
    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\"}"}

    KafkaProtocolInfo

    Kafka access protocol

    Used by actions: CheckRechargeKafkaServer, CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge.

    Name Type Required Description
    Protocol String No Protocol type. Supported protocol types include plaintext, sasl_plaintext, or sasl_ssl. Recommend using sasl_ssl. Protocol enables encrypted connection and also requires user authentication.

    -Protocol is required when IsEncryptionAddr is true.
    -Supported protocol types are as follows:
    -plaintext: Plaintext without encryption protocol
    -sasl_ssl: sasl authentication + ssl encryption
    -ssl: Pure ssl/TLS encryption protocol
    -sasl_plaintext: SASL authentication + unencrypted tunnel
    Mechanism String No Encryption type, supports PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.

    -Mechanism is required when Protocol is sasl_plaintext or sasl_ssl.
    -Supported encryption types are as follows.
    -PLAIN: plaintext authentication
    -SCRAM-SHA-256: Based on challenge-response mechanism, uses PBKDF2-HMAC-SHA256 algorithm.
    -SCRAM-SHA-512: Enhanced SCRAM that uses the PBKDF2-HMAC-SHA512 algorithm.
    UserName String No Username.
    Required when Protocol is sasl_plaintext or sasl_ssl
    Password String No User password.
    Required when Protocol is sasl_plaintext or sasl_ssl

    KafkaRechargeInfo

    Kafka data import configuration

    Used by actions: DescribeKafkaRecharges.

    Name Type Description
    Id String ID of Kafka data subscription configuration.
    TopicId String Log topic ID
    Name String Name of the Kafka import task
    KafkaType Integer Imports Kafka type. 0: Cloud CKafka; 1: user-built Kafka
    KafkaInstance String CKafka instance ID of cloud platform, required when KafkaType is 0.
    ServerAddr String Service address
    IsEncryptionAddr Boolean Whether ServerAddr is an encrypted connection
    Protocol KafkaProtocolInfo Encryption access protocol, which is required when IsEncryptionAddr is set to true
    UserKafkaTopics String The list of Kafka-related topics that the user needs to import. Separate multiple topics by commas.
    ConsumerGroupName String Kafka consumer group name of the user
    Status Integer Status. 1: Running; 2: Suspension.
    Offset Integer Data import position. -2: earliest (default); -1: latest
    CreateTime String Creation time. Format YYYY-MM-DD HH:MM:SS
    UpdateTime String Update time. Format: YYYY-MM-DD HH:MM:SS
    LogRechargeRule LogRechargeRuleInfo Log import rule
    UserKafkaMeta UserKafkaMeta User kafka extended information

    KeyRegexInfo

    Log keys to be filtered and the corresponding regex

    Used by actions: CreateConfig, CreateCosRecharge, ModifyConfig, ModifyCosRecharge.

    Name Type Required Description
    Key String Yes Log key to be filtered
    Regex String Yes Filter rule regex corresponding to key

    KeyValueInfo

    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.k
    4. 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

    Label

    Label structure.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Key String Yes The key of the tag. A valid tag key has two parts: an optional prefix and a name, separated by a slash (/). The name part is necessary and must be no more than 63 characters, starting and ending with alphanumeric characters ([a-z0-9A-Z]), with hyphens (-), underscores (_), dots (.), and alphanumerics in the middle. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), with a total length not exceeding 253 characters, followed by a slash (/).

    -Format of prefix [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
    -Format of name: ([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]
    -key must be unique
    Note: This field may return null, indicating that no valid values can be obtained.
    Operate String Yes The comparison operator between tag key values. Different business scenarios support different comparison operators. See the API business description for supported ones.
    such as in, notin
    Note: This field may return null, indicating that no valid values can be obtained.
    Values Array of String No Tag value.
    -Supports up to 63 characters.
    -Format: ([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]
    Note: This field may return null, indicating that no valid values can be obtained.

    LogContextInfo

    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 Log source host name
    RawLog String Raw log (only available when there is an error in creating the log index).
    IndexStatus String Cause for log index creation exception. It has a value only when a log index creation exception occurs.
    HighLights Array of HighLightItem Highlighted description of the log content

    LogInfo

    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
    HighLights Array of HighLightItem Keywords that meet search criteria are generally highlighted. Only key-value search is supported, not full-text search.
    LogJson String JSON serialized string of the log content
    HostName String Log source host name
    RawLog String Raw log (only available when there is an error in creating the log index).
    IndexStatus String Cause for log index creation exception. It has a value only when a log index creation exception occurs.

    LogItem

    Key-Value pair in log

    Used by actions: GetAlarmLog, SearchLog.

    Name Type Description
    Key String Log key
    Value String Log value

    LogItems

    LogItem array

    Used by actions: GetAlarmLog, SearchLog.

    Name Type Description
    Data Array of LogItem Key-Value pair returned in analysis result

    LogRechargeRuleInfo

    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 Use default time status. true: when enabled, current system time or Kafka message timestamp will be used as log timestamp. false: when disabled, time field in the log will be used as log timestamp. Default: true.
    LogRegex String No Full log matching rule. It is valid only when RechargeType is fullregex_log.
    UnMatchLogSwitch Boolean No Whether to upload the logs that failed to be parsed. Valid values: true and false.
    UnMatchLogKey String No key name of parsing-failed logs
    UnMatchLogTimeSrc Integer No Time source for parsing failure logs. 0: current time of the system; 1: Kafka message timestamp.
    DefaultTimeSrc Integer No Default time source. 0: Current system time; 1: Kafka message timestamp.
    TimeKey String No Time field. Field name representing time in logs.

    -When DefaultTimeSwitch is false and RechargeType data extraction mode is json_log JSON file log or fullregex_log single-line full regex file log, TimeKey cannot be empty.
    TimeRegex String No Time extraction regular expression.
    -When DefaultTimeSwitch is false and the data extraction mode of RechargeType is minimalist_log (single-line full text - file log), TimeRegex cannot be empty.
    -Only need to input the regular expression representing the time field in logs. If multiple fields are matched to, the first will be used.
    Example: The original log is "message with time 2022-08-08 14:20:20". You can set the retrieval time regex to \d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d.
    TimeFormat String No Time field format.
    -When DefaultTimeSwitch is false, TimeFormat cannot be empty.
    TimeZone String No Time field time zone.
    -When DefaultTimeSwitch is false, TimeZone cannot be empty.
    -Time zone format rule
    Prefix: Use GMT or UTC as the time zone benchmark.
    Offset:
    -- indicates a western time zone (later than the benchmark time).
    -+ means the east time zone (earlier than the benchmark time).
    -Format ±HH:MM (hr:min)

    -Currently supported:

    <br/>"GMT-12:00" <br/>"GMT-11:00" <br/>"GMT-10:00" <br/>"GMT-09:30" <br/>"GMT-09:00" <br/>"GMT-08:00" <br/>"GMT-07:00" <br/>"GMT-06:00" <br/>"GMT-05:00" <br/>"GMT-04:00" <br/>"GMT-03:30" <br/>"GMT-03:00" <br/>"GMT-02:00" <br/>"GMT-01:00" <br/>"GMT+00:00"<br/>"GMT+01:00"<br/>"GMT+02:00"<br/>"GMT+03:30"<br/>"GMT+04:00"<br/>"GMT+04:30"<br/>"GMT+05:00"<br/>"GMT+05:30"<br/>"GMT+05:45"<br/>"GMT+06:00"<br/>"GMT+06:30"<br/>"GMT+07:00"<br/>"GMT+08:00"<br/>"GMT+09:00"<br/>"GMT+09:30"<br/>"GMT+10:00"<br/>"GMT+10:30"<br/>"GMT+11:00"<br/>"GMT+11:30"<br/>"GMT+12:00"<br/>"GMT+12:45"<br/>"GMT+13:00"<br/>"GMT+14:00"<br/>"UTC-11:00"<br/>"UTC-10:00"<br/>"UTC-09:00"<br/>"UTC-08:00"<br/>"UTC-12:00"<br/>"UTC-07:00"<br/>"UTC-06:00"<br/>"UTC-05:00"<br/>"UTC-04:30"<br/>"UTC-04:00"<br/>"UTC-03:30"<br/>"UTC-03:00"<br/>"UTC-02:00"<br/>"UTC-01:00"<br/>"UTC+00:00"<br/>"UTC+01:00"<br/>"UTC+02:00"<br/>"UTC+03:00"<br/>"UTC+03:30"<br/>"UTC+04:00"<br/>"UTC+04:30"<br/>"UTC+05:00"<br/>"UTC+05:45"<br/>"UTC+06:00"<br/>"UTC+06:30"<br/>"UTC+07:00"<br/>"UTC+08:00"<br/>"UTC+09:00"<br/>"UTC+09:30"<br/>"UTC+10:00"<br/>"UTC+11:00"<br/>"UTC+12:00"<br/>"UTC+13:00"<br/>
    Metadata Array of String No Metadata information. Kafka import supports kafka_topic, kafka_partition, kafka_offset, and kafka_timestamp.
    Keys Array of String No log Key list. It is required when RechargeType is full_regex_log or delimiter_log.
    ParseArray Boolean No JSON parsing mode. The first-level data parsing is enabled.
    Delimiter String No Delimiter parsing mode - Separator
    This field is required when the parsing format is delimiter extraction.

    LogsetInfo

    Logset information

    Used by actions: DescribeLogsets.

    Name Type Description
    LogsetId String Logset ID
    LogsetName String Logset name
    CreateTime String Creation time. Format YYYY-MM-DD HH:MM:SS
    AssumerUin Integer If AssumerUin is not empty, it indicates the Uin of the service provider that created the log set.
    AssumerName String Cloud product identifier. When the logset is created by other cloud products, this field displays the cloud product name, such as CDN and TKE.
    Tags Array of Tag Tag bound to log set
    TopicCount Integer Number of log topics in logset
    RoleName String If AssumerName is not empty, it indicates the service provider who creates the logset.
    MetricTopicCount Integer Number of metric topics under log sets

    MachineGroupInfo

    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.
    Time format: yyyy-MM-dd HH:mm:ss
    Tags Array of Tag List of tags bound to machine group
    AutoUpdate String Whether machine group auto-update is enabled
    UpdateStartTime String Start time of upgrade. It is suggested to upgrade LogListener in the off-peak period of the business.
    Time format: HH:mm:ss
    UpdateEndTime String End time of upgrade. It is suggested to upgrade LogListener in the off-peak period of the business.
    Time format: HH:mm:ss.
    ServiceLogging Boolean Whether service logs are enabled to record logs generated by the LogListener service itself. Once enabled, it will create an internal log set cls_service_logging, and log topics including loglistener_status, loglistener_alarm, and loglistener_business, without incurring charges.
    DelayCleanupTime Integer Regular cleanup time for offline machines in the machine group, in days, default setting 30 days.
    MetaTags Array of MetaTagInfo Metadata information list of a machine group
    OSType Integer Operating system type, 0: Linux, 1: Windows

    MachineGroupTypeInfo

    Machine group type description

    Used by actions: AddMachineGroupInfo, CreateMachineGroup, DeleteMachineGroupInfo, DescribeConfigMachineGroups, DescribeMachineGroups, ModifyMachineGroup.

    Name Type Required Description
    Type String Yes Machine group type. Support ip and label.
    -ip: Indicates that Values in this machine group represent the ip address of the collection machine.
    -label: means the Values in this group contain machine tags
    Values Array of String No Machine description list.

    MachineInfo

    Machine status information

    Used by actions: DescribeMachines.

    Name Type Description
    Ip String Machine IP
    InstanceID String Machine instance ID.
    Status Integer Machine status. Valid values: 0: exceptional; 1: normal
    OfflineTime String Machine offline time. Null indicates normal. Return a specific time in case of exceptions. Time format: YYYY-MM-DD HH:mm:ss.
    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.

    Message

    session content

    Used by actions: ChatCompletions.

    Name Type Required Description
    Role String No

    Role

    Enumeration value:

    • user: User
    • assistant: AI assistant
    Content String No

    Text content
    ReasoningContent String No

    Thought chain content.
    Used to show the model thinking process, only available in deep thinking mode. Returned as an output parameter only. No need to import it into the input parameter during multi-round dialogue.
    ToolCalls Array of ToolCall No

    Tool call generated by the model. Only support output parameter return.

    MetaTagInfo

    Metadata information

    Used by actions: CreateConfig, CreateCosRecharge, CreateMachineGroup, DescribeConfigMachineGroups, DescribeMachineGroups, ModifyConfig, ModifyCosRecharge, ModifyMachineGroup.

    Name Type Required Description
    Key String No Metadata key
    Value String No Metadata value

    MetadataInfo

    Splunk task submission meta information

    Used by actions: CreateSplunkDeliver, DescribeSplunkDelivers, DescribeSplunkPreview, ModifySplunkDeliver.

    Name Type Required Description
    Format String Yes data format, rawlog/json
    MetaFields Array of String No Fields to be delivered, including SOURCE, FILENAME
    ,__TIMESTAMP__,__HOSTNAME__,__PKG_ID__
    EnableTag Boolean No Whether to deliver the TAG field
    TagJsonTiled Boolean No Whether JSON is flattened. Required when delivering the TAG field.

    MetadataItem

    Metadata array item

    Used by actions: ChatCompletions.

    Name Type Required Description
    Key String No

    Metadata tag key
    Value String No

    Metadata tag value

    MetricCollectConfig

    Metric collection configuration.

    Used by actions: DescribeClusterBaseMetricConfigs, DescribeClusterMetricConfigs, DescribeTopicBaseMetricConfigs, DescribeTopicMetricConfigs.

    Name Type Required Description
    ConfigId String No Collection configuration ID.
    TopicIds Array of String No Log topic ID.
    Source Integer No Collection configuration source. Support: 0, 1.
    -0: Self-build k8s
    - 1:TKE
    GroupIds Array of String No Machine group ID.
    Type Integer No Monitoring type. Supported values: 0, 1. Cannot be modified.

    -0: Basic monitoring
    -Custom monitoring
    Flag Integer No Collection configuration method. Supports 0 and 1. Cannot be modified.
    -0: Ordinary setting method. The Type field is only for: 1
    -YAML import method, Type can be 0 or 1.
    Name String No Name: Length not exceeding 253 characters, check format [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*.
    Note: This field may return null, indicating that no valid values can be obtained.
    Spec MetricSpec No Collection object. This parameter is valid only when Flag is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    MetricRelabels Array of Relabeling No Label processing. This parameter is valid only when Flag is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    MetricLabel MetricConfigLabel No Custom metadata. This parameter is valid only when Flag is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    Scheme String No Communication protocol. Valid values: HTTP and HTTPS. This parameter is valid only when Flag is 0.
    Note: This field may return null, indicating that no valid values can be obtained.
    ScrapeInterval String No Collection frequency. This parameter is valid only when Flag is 0.
    -Check format: ^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?&#124;0)$
    Note: This field may return null, indicating that no valid values can be obtained.
    ScrapeTimeout String No Collection timeout. This parameter is valid only when Flag=0 && Type=1.
    - format:^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?&#124;0)$

    Note: This field may return null, indicating that no valid values can be obtained.
    HonorLabels Boolean No How Prometheus handles tag conflicts. When Flag=0 takes effect, true and false are supported.

    - false: Rename conflicting tags in configuration data
    -true: Ignore server-side tag conflicts
    Note: This field may return null, indicating that no valid values can be obtained.
    YamlSpec MetricYamlSpec No Collection configuration, which is a string in YAML format. It is required when Flag is 1.
    Note: This field may return null, indicating that no valid values can be obtained.
    Operate Integer No Operation status. Valid values: 0: applied; 1: paused.
    CreateTime Integer No Creation time (a second-level timestamp).
    UpdateTime Integer No Update timestamp (second-level).

    MetricConfig

    Metric configuration information.

    Used by actions: CreateMetricSubscribe, DescribeMetricSubscribePreview, DescribeMetricSubscribes, ModifyMetricSubscribe.

    Name Type Required Description
    MetricName String Yes Metric name
    Periods Array of Integer Yes Statistical cycle (seconds).
    MetricLabels Array of MetricLabel No Custom metric label.

    MetricConfigLabel

    Configuration information of a metric collection label.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Metadata Array of String No Metadata.
    support
    - namespace
    - pod_name
    - pod_ip
    - pod_uid
    - container_name
    - container_id
    - image_name
    - cluster_id
    - node_id
    - node_ip
    Note: This field may return null, indicating that no valid values can be obtained.
    Label AppointLabel No Metadata Pod label information.
    Note: This field may return null, indicating that no valid values can be obtained.
    CustomLabels Array of CustomLabel No Custom label information.
    Note: This field may return null, indicating that no valid values can be obtained.

    MetricLabel

    Filters

    Used by actions: CreateMetricSubscribe, CreateRecordingRuleTask, CreateScheduledSql, DescribeMetricSubscribePreview, DescribeMetricSubscribes, DescribeRecordingRuleTask, ModifyMetricSubscribe, ModifyRecordingRuleTask, ModifyScheduledSql.

    Name Type Required Description
    Key String Yes Metric name
    Value String Yes Metric content.

    MetricSpec

    collection object

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    CustomSpecs Array of CustomMetricSpec No Custom metric collection configuration item.
    Note: This field may return null, indicating that no valid values can be obtained.

    MetricSubscribeInfo

    Metric subscription configuration information.

    Used by actions: DescribeMetricSubscribes.

    Name Type Description
    TaskId String Subscription task ID.
    TopicId String Log topic ID.
    Name String Subscription task name.
    Namespace String Cloud product namespace.
    Metrics Array of MetricConfig Metric configuration information.
    InstanceInfo InstanceConfig Instance configuration information.
    Enable Integer Subscription task switch. Valid values: 1: paused; 2: enabled.
    Status Integer Subscription task running status. Valid values: 0 creating; 1: paused; 2: running; 3: abnormal.
    ErrMsg String Error information occurred when a subscription task runs abnormally.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time (timestamp in seconds)
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime Integer Update time (second-level timestamp)
    Note: This field may return null, indicating that no valid values can be obtained.

    MetricYamlSpec

    Metric collection configuration in YAML format.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Type String Yes yaml monitoring type.
    Support:
    - PodMonitor
    - ServiceMonitor
    - ScrapeConfig
    - ScrapeConfig-prometheus

    PodMonitor, ServiceMonitor, ScrapeConfig belong to prometheus-operator
    ScrapeConfig-prometheus belongs to Prometheus
    Note: This field may return null, indicating that no valid values can be obtained.
    Spec String Yes Configures the YAML format.
    For example: Type: ServiceMonitor


    <br/>apiVersion: monitoring.coreos.com/v1<br/>kind: ServiceMonitor<br/>metadata:<br/> name: test<br/> namespace: test<br/> labels:<br/> k8s-app1: test<br/> k8s-app2: test<br/>spec:<br/> endpoints:<br/> - interval: 15s<br/> port: 8080-8080-tcp<br/> path: /metrics<br/> relabelings:<br/> - action: replace<br/> sourceLabels:<br/> - __meta_kubernetes_pod_label_app<br/> targetLabel: application<br/> namespaceSelector:<br/> matchNames:<br/> - test<br/> selector:<br/> matchLabels:<br/> app: test<br/>

    Note: This field may return null, indicating that no valid values can be obtained.

    MonitorNotice

    Offer multiple Notice messages

    Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

    Name Type Required Description
    Notices Array of MonitorNoticeRule No MonitorNoticeRule in array format

    MonitorNoticeRule

    Tencent Cloud observability platform notification channel group info

    Used by actions: CreateAlarm, ModifyAlarm.

    Name Type Required Description
    NoticeId String No

    Tencent Cloud observability platform notification template ID
    ContentTmplId String No

    ID of the Tencent Cloud observability platform content template. The default content template is used when empty.


    Note: This field may return null, indicating that no valid values can be obtained.
    AlarmLevels Array of Integer No

    Alarm level. 0: Warn; 1: Information; 2: Critical

    MonitorTime

    Monitoring task execution time point in alarm policy

    Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

    Name Type Required Description
    Type String Yes

    Execution cycle. Value range: Period, Fixed, Cron.

    • Period: at a fixed frequency
    • Fixed: fixed time
    • Cron: cron expression
    Time Integer No

    Execution period or custom execution time point. Unit: minutes, value range: 1-1440.
    When type is Period or Fixed, the time field takes effect.
    CronExpression String No

    The cron expression for the execution period. Example: 0/1 * * * *. From left to right, each field represents Minutes field, Hours field, Day of month field, Month field, Day of week field. No support for second level. When the type is Cron, the CronExpression field takes effect.

    MultiCondition

    Multiple trigger conditions.

    Used by actions: CreateAlarm, DescribeAlarms, ModifyAlarm.

    Name Type Required Description
    Condition String No Trigger conditions
    AlarmLevel Integer No Alarm severity. 0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical).

    - If not specified, the default is 0.

    MultiTopicSearchInformation

    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.

    NetInfo

    Splunk delivery task - Configure network information related to the target

    Used by actions: CreateSplunkDeliver, DescribeSplunkDelivers, ModifySplunkDeliver.

    Name Type Required Description
    Host String Yes Network address.
    Port Integer Yes Port.
    Token String Yes Authentication token
    NetType Integer Yes Network type; 1: Private network; 2: Public network
    VpcId String No Associated network; If the network type is private network, this field is required.
    VirtualGatewayType Integer No Network service type. If the network type is private network, this field is required.
    -0: Cloud cvm
    -3: Cloud Direct Connect Gateway
    -CCN
    -1025: Cloud clb
    IsSSL Boolean No Authentication mechanism, whether to use SSL, default non-use

    NetworkApplicationDetail

    Web Application Task Detail

    Used by actions: DescribeNetworkApplicationDetail.

    Name Type Description
    NetworkAppId String Web application Id
    Name String network app name
    Region String Region code
    TopicId String log topic id
    LogsetId String Logset id
    Token String Application token
    Uin Integer Host Account ID
    SubUin Integer Sub-account ID
    CreateTime Integer Creation time (a second-level timestamp)
    UpdateTime Integer Update time (a second-level timestamp)

    NetworkApplicationInfo

    Network application task info

    Used by actions: DescribeNetworkApplications.

    Name Type Description
    NetworkAppId String Web application Id
    Name String Network app name
    Region String Region code
    TopicId String Log topic id
    LogsetId String log set id
    Uin Integer Host Account ID
    SubUin Integer Sub-account ID
    CreateTime Integer Creation time, timestamp in seconds
    UpdateTime Integer Update time (second-level timestamp)

    NoticeContent

    Detailed configuration of a notification content template.

    Used by actions: CreateNoticeContent, DescribeNoticeContents, ModifyNoticeContent.

    Name Type Required Description
    Type String Yes Channel type

    Email: mail; Sms: Sms; WeChat: WeChat; Phone: call; WeCom: WeCom; DingTalk: DingTalk; Lark: Lark; Http: Custom Callback
    TriggerContent NoticeContentInfo No Alarm trigger notification content template.
    RecoveryContent NoticeContentInfo No Alarm clearing notification content template.

    NoticeContentInfo

    Notification template content.

    Used by actions: CreateNoticeContent, ModifyNoticeContent.

    Name Type Required Description
    Title String No Notification content template title information.
    Some notification channel types do not support "title". See the Tencent Cloud Console page (https://console.tencentcloud.com/cls/alarm/notice-template).
    Content String No Body information of a notification content template.
    Headers Array of String No Request Headers: The Request header in an HTTP Request contains additional information sent to server, such as user agent, authorization credentials, expected response format.
    Only "Custom Callback" supports this configuration.

    NoticeContentTemplate

    Notification content template information.

    Used by actions: DescribeNoticeContents.

    Name Type Description
    NoticeContentId String Notification content template ID.
    Name String notification content template name
    Type Integer Language type.

    0: Chinese
    1: English
    NoticeContents Array of NoticeContent Notification content template information.
    Flag Integer Notification content template tag.

    0: user-customized
    1: Built-in
    Uin Integer Root account of a creator.
    SubUin Integer Sub-account of a creator or modifier.
    CreateTime Integer Creation time. A timestamp in seconds.
    UpdateTime Integer Update time. A timestamp in seconds.

    NoticeReceiver

    Alarm notification recipient information

    Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.

    Name Type Required Description
    ReceiverType String Yes Recipient type. Available values:
    -Uin - User ID
    -Group - User group ID
    Other recipient types are not currently supported.
    ReceiverIds Array of Integer Yes Recipient.
    When ReceiverType is Uin, the value of ReceiverIds is the user uid. Sub-user information query
    When ReceiverType is Group, ReceiverIds is the user Group id. CAM User Group
    ReceiverChannels Array of String Yes Notification receiving channel
    -Mail
    -Sms
    -WeChat
    -Phone - phone
    NoticeContentId String No Notification content template ID. Use Default-zh to refer to the Default template (Chinese). Use Default-en to refer to DefaultTemplate (English). Get the notification content template ID by searching the notification content template (https://www.tencentcloud.com/document/product/614/111714?from_cn_redirect=1).
    StartTime String No Start time to allow receipt of information. Format: 15:04:05. Required.
    EndTime String No Allow receipt of information end time. Format: 15:04:05. Required
    Index Integer No Bit order.

    -Invalid when passed as an input parameter.
    -Valid at that time.

    NoticeRule

    Notification rules

    Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.

    Name Type Required Description
    Rule String No Match rule JSON string.
    rule tree format is a nested structure JSON string
    {"Value":"AND","Type":"Operation","Children":[{"Value":"OR","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1,0]","Type":"Value"}]},{"Type":"Condition","Value":"Level","Children":[{"Value":"NotIn","Type":"Compare"},{"Value":"[2]","Type":"Value"}]}]}]}

    Rule tree limiting rules are as follows:
    -Valid values for Type in the top-level rule: Condition, Operation
    -Valid values for the Type of the Operation sub-node: Condition, Operation
    -Valid values for the Type of a Condition sub-node: String, Compare, Array, TimeRange, Value, Key.
    -Other types have no sub-node
    -When rule Type is Operation, the valid values for value are AND, OR.
    -When rule Type is Condition, value is required and the number of child nodes cannot be less than 2.
    -When the sub-node Type is Compare, the valid values for value are >, <, >=, <=, =, !=, Between, NotBetween, =~, !=~, In, NotIn.
    -When the value is Between or NotBetween, the next sub-node value must be an array of length 2.
    -When the value is =~ or !=~, the next sub-node value must be a regular expression.
    -When value is In or NotIn, the next sub-node value must be an array.

    Business parameter meaning:
    -Type: Condition means the rule condition. Value: Level means the alarm level.
    -Sub-node Type supports Compare, and Value supports In and NotIn.
    -Supported values for the next sub-node value: 0 (warning), 1 (reminder), 2 (critical).
    The following example means the alarm level belongs to reminder.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}

    -Type: Condition means rule condition. Value: NotifyType refers to notification type.
    -Sub-node Type supports Compare, and Value supports In and NotIn.
    -Supported values for the next sub-node value: 1 (alarm notification), 2 (recovery notification).
    The following example means the notification type belongs to alarm notification or the notification type is not within restoration notification.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}

    -Type: Condition means rule condition. Value: AlarmID indicates alarm policy.
    -Sub-node Type supports Compare, and Value supports In and NotIn.
    -Supported values for the next sub-node value: alarm policy id array.
    The following example means: The alarm policy belongs to alarm-53af048c-254b-4c73-bb48-xxx, alarm-6dfa8bc5-08da-4d64-b6cb-xxx or the alarm policy does not belong to alarm-1036314c-1e49-4cee-a8fb-xxx.
    "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"

    -Type: Condition means the rule condition. Value: AlarmName means the alarm policy name.
    -Sub-node Type supports Compare, and Value supports =~, !=~
    -Next sub-node value supported values: Must be a regular expression.
    The following example means the alarm policy name regular expression matching ^test$ or the alarm policy name regular expression mismatch ^hahaha$.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}

    -Type: Condition means rule condition. Value: Label refers to alarm classification field.
    - The sub-node Type supports Compare, and Value supports In, NotIn, =~, !=~.
    -Supported values for the next sub-node value: In, NotIn where value is an array, =~, !=~ where value is a regex.
    The following example means: the alarm classification field key1 belongs to v1, or the alarm classification field key2 NOT_IN v2, or the alarm classification field key3 matches the regular expression ^test$, or the alarm classification field key4 does not match the regular expression ^hahaha$.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}

    -Type: Condition means Rule Condition. Value: NotifyTime refers to notification time.
    - Sub-node Type supports Compare, and Value supports Between, NotBetween
    -Next sub-node value supported values: An array of strings with a length of 2 in the format 14:20:36.
    The following example indicates the notification time is within the specified scope 14:18:36 to 14:33:36 or not within specified range 14:20:36 to 14:30:36.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}

    -Type: Condition means the rule condition. Value: Duration indicates the duration of the alarm.
    -The sub-node Type supports Compare, and Value supports >, <, >=, <=.
    -Next sub-node value supported values: integer value in minutes
    The following example means: the duration of the alarm is greater than 1 minute, equal to or greater than 2 minutes, less than 3 minutes, or less than or equal to 4 minutes.
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}
    NoticeReceivers Array of NoticeReceiver No Alarm notification recipient information.
    WebCallbacks Array of WebCallback No Alarm notification template callback information, including WeCom, DingTalk, and Lark.
    Escalate Boolean No Alarm escalation switch. true: enable alarm escalation, false: disable alarm escalation. Default: false.
    Type Integer No Alarm escalation conditions. 1: Unclaimed and unrecovered, 2: Unrecovered. Default is 1.
    -Unclaimed and unrecovered: Upgrade if the alert is not restored and no one claims it.
    -Unrecovered: Upgrade if the alarm persists without recovery.
    Interval Integer No Escalate alarms interval. Unit: minutes, range [1, 14400].
    EscalateNotice EscalateNoticeInfo No Notification channel configuration for the next step after alarm severity escalation.

    ParquetInfo

    Parquet contents

    Used by actions: CreateShipper, ModifyShipper.

    Name Type Required Description
    ParquetKeyInfo Array of ParquetKeyInfo Yes ParquetKeyInfo array

    ParquetKeyInfo

    Parquet content description

    Used by actions: CreateShipper, 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 Assigned value for parsing failure

    PartitionInfo

    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
    Time format: yyyy-MM-dd HH:mm:ss
    LastWriteTime String Time to stop writing data to the read-only partition
    Time format: yyyy-MM-dd HH:mm:ss
    Note: This field may return null, indicating that no valid values can be obtained.

    PartitionOffsetInfo

    PartitionOffsetInfo

    Used by actions: CommitConsumerOffsets, DescribeConsumerOffsets.

    Name Type Required Description
    PartitionId Integer Yes Partition ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Offset Integer No Offset.
    Note: This field may return null, indicating that no valid values can be obtained.

    PreviewLogStatistic

    Preview data details

    Used by actions: CreateDataTransform.

    Name Type Required Description
    LogContent String Yes Log content
    LineNum Integer Yes Line number. Starts from 0.
    DstTopicId String No target log topic ID
    -Obtain the log topic Id through Get Log Topic List.
    FailReason String No Error message for failure. A null string "" indicates normal.
    Time String No Log time, format: 2024-05-07 17:13:17.105

    -Invalid input parameter
    -Valid at that time, the time format in logs

    RebuildIndexTaskInfo

    Index rebuild task information

    Used by actions: DescribeRebuildIndexTasks.

    Name Type Description
    TaskId String Reindexing task ID
    Status Integer Current status of the reindexing task. 0: reindexing task created; 1: creating reindexing resources; 2: reindexing resources created; 3: reindexing; 4: paused; 5: reindexing completed; 6: reindexing succeeded (searchable); 7: reindexing failed; 8: revoked; 9: deleting the metadata and index.
    StartTime Integer Start timestamp of the reindexing task
    EndTime Integer Rebuild task end timestamp
    RemainTime Integer Estimated remaining time for reshipping, in seconds
    CreateTime Integer Rebuild task creation timestamp
    Progress Float Re-shipping completion degree, in percentages.
    UpdateTime Integer Update time of the reindexing task
    StatusMessage String Additional status description. Currently, it only describes the reason for failure.

    RecordingRuleTaskInfo

    Pre-aggregation task details.

    Used by actions: DescribeRecordingRuleTask.

    Name Type Description
    TaskId String Pre-aggregation task ID.
    TopicId String Source Log Topic ID
    Name String Pre-aggregation task name.
    CreateTime String Creation Time
    UpdateTime String Task Update Time
    Status Integer Task status: 1: Running 2: Stopped 3: Error - Source log topic not found 4: Error - Target topic not found

    5: Access permission issue 6: Internal failure 7: Other faults
    EnableFlag Integer Task status: 1 Enabled, 2 Disabled
    ProcessStartTime Integer Schedule Start Time
    ProcessPeriod Integer Scheduling Interval (Minutes)
    ProcessDelay Integer Execution Delay (Seconds)
    HasServicesLog Integer Whether to enable service log shipping. Valid values: 1: disable; 2: enable.
    RecordingRuleContent String Pre-aggregation search statement.
    MetricName String Metric name
    CustomMetricLabels Array of MetricLabel Custom metric name.
    YamlId String YAML configuration file ID.
    YamlConfigName String YAML configuration file name.
    DstTopicId String Target log topic ID

    RecordingRuleYamlTaskInfo

    Pre-aggregation YAML task details.

    Used by actions: DescribeRecordingRuleYamlTask.

    Name Type Description
    YamlId String YAML configuration file ID.
    TopicId String Source Log Topic ID
    DstTopicId String Log topic ID for the write description.
    CreateTime String Creation Time
    UpdateTime String Task Update Time
    Status Integer Task status, 1: running 2: stopped 3: error - source log topic not found 4: error - destination topic not found

    5: Access permission issue 6: Internal failure 7: Other faults
    EnableFlag Integer Task status: 1 Enabled, 2 Disabled
    ProcessStartTime Integer Schedule Start Time
    ProcessPeriod Integer Scheduling Interval (Minutes)
    ProcessDelay Integer Execution Delay (Seconds)
    HasServicesLog Integer Whether to enable service log shipping. Valid values: 1: disable; 2: enable.
    YamlConfigName String YAML configuration file name.
    YamlContent String YAML configuration file content.
    SubTaskCount Integer Number of subtasks of the YAML file.

    Relabeling

    Tag remark configuration.
    Permission to dynamically rewrite the tag set of targets, alerts, captured samples and remote write samples.

    Used by actions: CreateMetricConfig, DescribeClusterMetricConfigs, DescribeTopicMetricConfigs, ModifyMetricConfig.

    Name Type Required Description
    Action String Yes Action executed based on regular expression matching.
    -replace: Label replacement, required: SourceLabels, Separator, Regex, TargetLabel, Replacement
    -labeldrop: Discard Label, Required: Regex
    -labelkeep: Reserve Label, required: Regex
    -lowercase, required: SourceLabels, Separator, TargetLabel
    -Uppercase: uppercase, Required: SourceLabels, Separator, TargetLabel
    -dropequal: Drop metric - exact match, required: SourceLabels, Separator, TargetLabel
    -keepequal: retain metric - exact match, required: SourceLabels, Separator, TargetLabel
    -drop: Drop metric - Regular expression matching. Required: SourceLabels, Separator, Regex.
    -keep: Retain metric - Regular expression matching, Required: SourceLabels, Separator, Regex
    -hashmod: hash modulo, required: SourceLabels, Separator, TargetLabel, Modulus
    -labelmap: Label map, required: Regex, Replacement
    Note: This field may return null, indicating that no valid values can be obtained.
    SourceLabels Array of String No original label
    Note: This field may return null, indicating that no valid values can be obtained.
    Separator String No Original label delimiter. This parameter cannot be an empty string when it is required. Its length cannot exceed 256 characters.
    Note: This field may return null, indicating that no valid values can be obtained.
    TargetLabel String No Target label. This parameter cannot be an empty string when it is required. The verification format is ^[a-zA-Z_][a-zA-Z0-9_]*$, and its length cannot exceed 256 characters.
    Note: This field may return null, indicating that no valid values can be obtained.
    Replacement String No Replacement value. If regular expression matching is performed, execute the replacement operation.
    -Cannot be an empty string when required. Length cannot exceed 256.
    -When the action is LabelMap, check format for Replacement: ^(?:(?:[a-zA-Z_]&#124;\$(?:\{\w+\}&#124;\w+))+\w*)+$
    Note: This field may return null, indicating that no valid values can be obtained.
    Regex String No Regular expression. The matching value is extracted. This parameter cannot be an empty string when it is required. The regular expression should be a valid RE2.
    Note: This field may return null, indicating that no valid values can be obtained.
    Modulus Integer No Obtains the hash value of a label value. This parameter cannot be empty or 0 when it is required.
    Note: This field may return null, indicating that no valid values can be obtained.

    RuleInfo

    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.

    RuleKeyValueInfo

    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

    RuleTagInfo

    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

    ScheduledSqlResouceInfo

    Resource information for ScheduledSql

    Used by actions: CreateScheduledSql, DescribeScheduledSqlInfo, ModifyScheduledSql.

    Name Type Required Description
    TopicId String Yes Obtain the log topic Id through Get Log Topic List.
    Region String No Regional information of the topic. Cross-region selection is not supported currently. For supported regions, see the region list (https://www.tencentcloud.com/document/api/614/56474?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) document.
    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.

    ScheduledSqlTaskInfo

    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 Task creation time. Format: yyyy-MM-dd HH:mm:ss
    UpdateTime String Task update time. Format: yyyy-MM-dd HH:mm:ss
    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. Format: yyyy-MM-dd HH:mm:ss
    ProcessType Integer Schedule Type: 1 Continuous Running 2 Specified Time Range
    ProcessEndTime String Schedule End Time, format: yyyy-MM-dd HH:mm:ss, required when process_type=2
    ProcessPeriod Integer Scheduling cycle (minutes), 1-1440 minutes
    ProcessTimeWindow String Query Time Window. @m-15m, @m, meaning the last 15 minutes
    ProcessDelay Integer Execution delay (seconds), 0-120 seconds, default 60
    SrcTopicRegion String Regional information of the source topicId. Supported regions are listed in the region list document (https://www.tencentcloud.com/document/api/614/56474?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8).
    SyntaxRule Integer Syntax rules. 0: Lucene syntax; 1: CQL syntax.
    HasServicesLog Integer Whether to enable service log shipping. Valid values: 1: disable; 2: enable.
    FullQuery Integer Full-text search tag. 1: Off, 2: On.

    SearchLogErrors

    Error information for multi-log topic search

    Used by actions: SearchLog.

    Name Type Description
    TopicId String Log topic ID
    ErrorMsg String Error message
    ErrorCodeStr String Error code.

    SearchLogInfos

    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 Pass through the Context value returned by this API, which can access more logs later, with an expiration time of 1 hour.

    SearchLogTopics

    Multi-topic search return information

    Used by actions: SearchLog.

    Name Type Description
    Errors Array of SearchLogErrors Error information corresponding to multi-log topic retrieval
    Infos Array of SearchLogInfos Information for each log topic during multi-log topic retrieval

    SearchViewInfo

    Query view info

    Used by actions: DescribeSearchViews.

    Name Type Description
    ViewId String

    View ID
    ViewName String

    View name
    ViewType String

    View type

    Enumeration value:

    • log: Log topic
    • metric: Metric topic
    LogsetId String

    Logset id

    Logset of the view
    LogsetRegion String

    Region of the logset

    Parameter format: ap-guangzhou
    Topics Array of ViewSearchTopic

    View log topic information
    Description String

    View description
    CreateTime Integer

    Creation time

    Unit: second-level timestamp
    UpdateTime Integer

    Update time

    Measurement unit: second-level timestamp

    ShipperInfo

    Shipping rule

    Used by actions: DescribeShippers.

    Name Type Description
    ShipperId String

    Delivery Rule ID
    TopicId String

    Log topic ID.
    Bucket String

    bucket address for shipping
    Prefix String

    Delivery prefix directory
    ShipperName String

    Shipping rule name
    Interval Integer

    Shipping time interval. Unit: seconds
    MaxSize Integer

    Maximum value of delivered files in MB
    Status Boolean

    Whether effective
    FilterRules Array of FilterRuleInfo

    Filter rules for log shipping
    Partition String

    Partition rules for log shipping support strftime time format representation
    Compress CompressInfo

    Compression configuration of shipped logs
    Content ContentInfo

    Content format configuration for shipped logs
    CreateTime String

    Creation time of shipped logs. Format: YYYY-MM-DD HH:MM:SS
    FilenameMode Integer

    Delivery file naming configuration. 0: Random number naming, 1: Delivery time naming. Default: 0 (Random number naming).
    StartTime Integer

    Start time of the data shipping range
    EndTime Integer

    End time of the data delivery range
    Progress Float

    Progress of historical data delivery (valid only when users select historical data within the dataset)
    RemainTime Integer

    Remaining time for all historical data delivery completion (valid only when there is historical data in the selected data)

    Unit: second
    HistoryStatus Integer

    Historical task status:
    0: Real-time task
    1: Task preparing
    2: Task running
    3: Task execution exception
    4: Task execution complete
    StorageType String

    Storage type. Default value is STANDARD. For enumeration values, see the storage type overview document.
    Reference values:
    STANDARD: standard storage
    STANDARD_IA: infrequent storage
    ARCHIVE: archive storage
    DEEP_ARCHIVE: deep archive storage
    MAZ_STANDARD: standard storage (multi-AZ)
    MAZ_STANDARD_IA: infrequent storage (multi-AZ)
    INTELLIGENT_TIERING: intelligent tiering storage
    MAZ_INTELLIGENT_TIERING: intelligent tiering storage (multi-AZ)
    RoleArn String

    ARN Create role
    ExternalId String

    External ID
    TaskStatus Integer

    Task running status. Supports 0, 1, 2

    • 0: Stop
    • 1: Running
    • 2: Exception
    TimeZone String

    Time variable used to generate the file path shipped to COS
    DSLFilter String

    Pre-filtering process - filter out original data before writing to COS

    ShipperTaskInfo

    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 this shipping: "success", "running", "failed".

    -success: Task successful.
    - running: Task processing.
    - failed: Task failure.
    Message String Result details

    SplunkDeliverInfo

    Delivery task information of Splunk

    Used by actions: DescribeSplunkDelivers.

    Name Type Description
    TaskId String

    Task ID.
    Name String

    Task Name
    Uin Integer

    User id
    TopicId String

    Log topic id
    Status Integer

    Task status; 1. Running; 2. Suspended; 3. Exception
    Enable Integer

    Enable status; 0: Disabled; 1: Enabled
    CreateTime Integer

    Creation time; unit: second
    UpdateTime Integer

    Update time; Unit: seconds
    NetInfo NetInfo

    splunk delivery task - target configuration
    Metadata MetadataInfo

    splunk delivery task meta-information
    HasServiceLog Integer

    Whether to enable service logs; 1: disable; 2: enable
    Source String

    Advanced configuration - data source;
    SourceType String

    Advanced configuration - data source type;
    Index String

    Advanced configuration - Splunk write indexes
    IndexAck Integer

    Advanced configuration - Whether to enable indexer; 1 - not enabled; 2 - enable;
    Channel String

    Advanced configuration - Channel
    DSLFilter String

    Pre-filtering process - perform pre-filtering statements on original data written to Splunk
    ExternalRole ExternalRole

    Advanced configuration - Cross-account delivery parameter

    Tag

    Description of the tag pair bound to a resource instance when it is created

    Used by actions: CreateAlarm, CreateAlarmNotice, CreateCloudProductLogCollection, CreateConsole, CreateDashboard, CreateLogset, CreateMachineGroup, CreateTopic, DescribeAlarmNotices, DescribeAlarms, DescribeConfigMachineGroups, DescribeConsoles, DescribeLogsets, DescribeMachineGroups, DescribeTopics, ModifyAlarm, ModifyAlarmNotice, ModifyDashboard, ModifyLogset, ModifyMachineGroup, ModifyTopic.

    Name Type Required Description
    Key String Yes Tag key.
    Value String Yes Tag value.

    ToolCall

    Model-generated tool call

    Used by actions: ChatCompletions.

    Name Type Required Description
    Id String No

    Tool call id
    Type String No

    Invocation type of the tool, currently only support function
    Function ToolCallFunction No

    Specific function call
    Index Integer No

    Index value

    ToolCallFunction

    Specific Tool Call Function call

    Used by actions: ChatCompletions.

    Name Type Required Description
    Name String No

    Function name
    Arguments String No

    Function parameter, usually a json string

    TopicExtendInfo

    Log topic extension information.

    Used by actions: CreateTopic, DescribeTopics, ModifyTopic.

    Name Type Required Description
    AnonymousAccess AnonymousInfo No Log topic authentication-free configuration information.
    Note: This field may return null, indicating that no valid values can be obtained.

    TopicInfo

    Basic Topic Information

    Used by actions: DescribeTopics.

    Name Type Description
    LogsetId String

    Logset ID
    TopicId String

    Topic ID
    TopicName String

    Topic name
    PartitionCount Integer

    Topic partition count
    Index Boolean

    Whether the topic has indexing enabled (the topic type must be log topic)
    AssumerUin Integer

    If AssumerUin is not empty, it indicates the Uin of the service provider creating the log topic
    AssumerName String

    Cloud product identifier. When the topic is created by other cloud products, this field displays the cloud product name, such as CDN, TKE.
    CreateTime String

    Creation time. Format: yyyy-MM-dd HH:mm:ss
    Status Boolean

    Whether the topic has log collection enabled. true: enable collection; false: disable collection.
    Enabled by default during log topic creation. You can modify this field via SDK invocation of ModifyTopic.
    The console currently does not support modification of this parameter.
    Tags Array of Tag

    Tag information bound to the topic
    RoleName String

    If RoleName is not empty, it indicates the role used by the service provider creating the log topic
    AutoSplit Boolean

    Whether the topic has auto-split enabled
    MaxSplitPartitions Integer

    Maximum number of partitions allowed for the topic if auto-split is enabled
    StorageType String

    Storage type of the topic

    • hot: standard storage
    • cold: infrequent storage
    Period Integer

    Lifecycle in days, valid values 1~3600. A value of 3640 indicates permanent retention.
    SubAssumerName String

    Cloud product sub-identifier. When the log topic is created by other cloud products, this field displays the cloud product name and its log type sub-category, such as TKE-Audit, TKE-Event. Some cloud products only have the cloud product identifier (AssumerName) without this field.
    Describes String

    Topic description
    HotPeriod Integer

    Enable log settlement, lifecycle of standard storage, hotPeriod < Period.
    Standard storage is hotPeriod, infrequent storage is Period-hotPeriod. (Topic type must be log topic)
    HotPeriod=0 means log settlement is not enabled.
    KeyId String

    kms-cls service key id
    BizType Integer

    Topic type.

    • 0: Log topic
    • 1: Metric topic
    IsWebTracking Boolean

    Free authentication switch. false: disabled; true: enabled.
    Once enabled, designated operations will be supported for anonymous access to the log topic. See log topic for details.
    Extends TopicExtendInfo

    Log topic extended information
    TopicAsyncTaskID String

    Async migration task ID
    MigrationStatus Integer

    Asynchronous migration status

    • 1: In progress
    • 2: Completed
    • 3: Failure
    • 4: Canceled
    EffectiveDate String

    After async migration, expected effective date
    Time format: yyyy-MM-dd HH:mm:ss
    IsSourceFrom Boolean

    IsSourceFrom Enable recording public network source IP and server receipt time
    BillingMode Integer

    Current billing mode

    Enumeration value:

    • 0: Function billing by usage
    • 1: Billing by raw log size (currently supported for some customers only)
    NewBillingMode Integer

    If there is an async task, the new billing model after the task succeeds

    Enumeration value:

    • 0: Function billing by usage
    • 1: Billing by raw log size (currently only supported for some customers)

    TopicPartitionInfo

    Partitions

    Used by actions: SendConsumerHeartbeat.

    Name Type Required Description
    TopicID String Yes Log topic ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Partitions Array of Integer Yes Partition ID list.
    Note: This field may return null, indicating that no valid values can be obtained.

    TopicPartitionOffsetInfo

    TopicPartitionOffsetInfo

    Used by actions: CommitConsumerOffsets, DescribeConsumerOffsets.

    Name Type Required Description
    TopicID String Yes Log topic id
    Note: This field may return null, indicating that no valid values can be obtained.
    PartitionOffsets Array of PartitionOffsetInfo Yes Partition offset information.
    Note: This field may return null, indicating that no valid values can be obtained.

    UserKafkaMeta

    User kafka extended information

    Used by actions: CheckRechargeKafkaServer, CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge.

    Name Type Required Description
    KafkaVersion String Yes User kafka version
    Support the following versions:
    - 0.10.2.0
    - 1.0.0
    - 2.0.0
    - 2.2.0
    - 2.4.0
    - 2.6.0
    - 2.7.0
    - 2.8.0
    - 3.0.0
    - 3.2.0

    ValueInfo

    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. Supported types: long, text, double, json.
    Note: The json data type is currently supported by partial users or log topics. If needed, contact us to enable the allowlist.
    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 to include node data. Set this parameter to false for the long and double fields.
    Alias String No field alias
    OpenIndexForChildOnly Boolean No Enable index only for sub-node. This field is not enabled.
    Note: Only json type fields can configure this parameter.
    ChildNode Array of KeyValueInfo No subnode list
    Note: Only json type fields can configure this parameter.

    ViewSearchTopic

    Query view topic configuration

    Used by actions: CreateSearchView, DescribeSearchViews, ModifySearchView.

    Name Type Required Description
    Region String Yes

    Region of the logset and topic

    Parameter format: ap-guangzhou

    In the same query view, each topic must be in the same region.
    LogsetId String Yes

    Log set id
    TopicId String Yes

    Log topic id

    WebCallback

    Callback address

    Used by actions: CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice.

    Name Type Required Description
    CallbackType String Yes Callback type. Valid values:
    -Http (custom webhook configuration)
    -WeCom
    -DingTalk
    -Lark
    Url String Yes Callback URL, supports a maximum of 1024 bytes.
    You can also use WebCallbackId to refer to the URL in the integration configuration. At this point, please enter an empty string for this field.
    WebCallbackId String No Integration configuration ID. Obtain the integration configuration ID by searching the alarm channel callback configuration list (https://www.tencentcloud.com/document/product/614/115229?from_cn_redirect=1).
    Method String No Callback method. Valid values:
    -POST (default value)
    - PUT

    Note:
    -Required when CallbackType is Http. No need to specify for other callback methods.
    NoticeContentId String No Notification content template ID. When Default-zh is used, DefaultTemplate (Chinese) is referenced. When Default-en is used, DefaultTemplate (English) is referenced.
    RemindType Integer No Reminder type.

    0: No reminder; 1: Specified individual; 2: Everyone
    Mobiles Array of String No Mobile phone list.
    UserIds Array of String No User ID list.
    Index Integer No Serial number.
    -Invalid input parameter.
    -Output parameter is valid.

    WebCallbackInfo

    Alarm channel callback configuration information.

    Used by actions: DescribeWebCallbacks.

    Name Type Description
    WebCallbackId String Alarm channel callback configuration ID.
    Name String Alarm channel callback configuration name.
    Type String Channel type

    WeCom: WeCom; DingTalk: DingTalk; Lark: Lark; Http: Custom Callback;
    Webhook String Callback URL.
    Method String Request method.
    Key String Key information.
    Uin Integer Root account.
    SubUin Integer Sub-account.
    CreateTime Integer Creation time. A timestamp in seconds.
    UpdateTime Integer Update time. A timestamp in seconds.
    上一篇: ModifyNetworkApplication下一篇: Error Codes

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈