Querying Log Ingestion Configurations

project_id

Yes

String

Parameter description:

Project ID. For details about how to obtain it, see Obtaining the Account ID, Project Resource Set ID, Log Group ID, and Log Stream ID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

X-Auth-Token

Yes

String

Parameter description:

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Content-Type

Yes

String

Parameter description:

Set this parameter to application/json;charset=UTF-8.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

access_config_name_list

No

Array of strings

Parameter description:

List of ingestion configuration names.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

host_group_name_list

No

Array of strings

Parameter description:

Host group name list.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

log_group_name_list

No

Array of strings

Parameter description:

Log group name list.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

log_stream_name_list

No

Array of strings

Parameter description:

Log stream name list.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

access_config_tag_list

No

Array of accessConfigTag objects

Parameter description:

Ingestion configuration tags.

Constraints:

A tag key must be unique. Up to 20 tags are allowed.

Value range:

N/A.

Default value:

N/A.

key

No

String

Parameter description:

Tag key, which must be unique.

Constraints:

N/A.

Value range:

It can contain up to 128 characters, including only letters, digits, spaces, and special characters (_.:=+-@). Do not start or end with a space, nor start with sys.

value

No

String

Parameter description:

Tag value.

Value range:

It can contain up to 255 characters, including only letters, digits, spaces, and special characters (_.:=+-@).

result

Array of AccessConfigInfo objects

Parameter description:

Ingestion configuration list.

Value range:

N/A.

total

Long

Parameter description:

Total number of ingestion configurations.

Value range:

N/A.

access_config_id

String

Parameter description:

Ingestion configuration ID.

Value range:

N/A.

access_config_name

String

Parameter description:

Ingestion configuration name.

Value range:

N/A.

access_config_type

String

Parameter description:

Ingestion configuration type.

The value can be AGENT (ECS log ingestion) or K8S_CCE (CCE log ingestion).

Value range:

N/A.

create_time

Long

Parameter description:

Creation time.

Value range:

N/A.

access_config_detail

AccessConfigDeatilCreate object

Parameter description:

Ingestion configuration details.

Value range:

N/A.

log_info

AccessConfigQueryLogInfo object

Parameter description:

Log details.

Value range:

N/A.

host_group_info

AccessConfigHostGroupIdList object

Parameter description:

Host group ID list.

Value range:

N/A.

access_config_tag

Array of accessConfigTag objects

Parameter description:

Tag information. A tag key must be unique. Up to 20 tags are allowed.

Value range:

N/A.

log_split

Boolean

Parameter description:

Log splitting.

Value range:

N/A.

binary_collect

Boolean

Parameter description:

Binary file collection.

Value range:

N/A.

cluster_id

String

Parameter description:

CCE cluster ID.

Value range:

N/A.

encoding_format

String

Parameter description:

Encoding format. The default format is UTF-8.

Value range:

N/A.

incremental_collect

Boolean

Parameter description:

Collection policy. The value can be incremental.

Value range:

N/A.

processor_type

String

Parameter description:

ICAgent structuring parsing type.

Value range:

N/A.

demo_log

String

Parameter description:

Sample log event.

Value range:

N/A.

demo_fields

Array of DemoFieldAccess objects

Parameter description:

Parsing fields of the sample log event.

Value range:

N/A.

processors

Array of Processor objects

Parameter description:

ICAgent structuring parser.

Value range:

N/A.

application_id

String

Parameter description:

ServiceStage application ID.

Value range:

N/A.

environment_id

String

Parameter description:

ServiceStage environment ID.

Value range:

N/A.

component_id

Array of strings

Parameter description:

ServiceStage component ID.

Value range:

N/A.

paths

Array of strings

Parameter description:

Collection paths.

1. A path must start with a slash (/) or Letter:\.

2. A path cannot contain only slashes (/). The following special characters are not allowed: <>'|".

3. A path cannot start with /** or /*.

4. Only one double asterisk (**) can be contained in a path.

The container path and host path are mandatory for the CCE type and are not mandatory for the standard output.

Value range:

N/A.

black_paths

Array of strings

Parameter description:

Collection path blacklist.

1. A path must start with a slash (/) or Letter:\.

2. A path cannot contain only slashes (/). The following special characters are not allowed: <>'|".

3. A path cannot start with /** or /*.

4. Only one double asterisk (**) can be contained in a path.

Value range:

N/A.

format

AccessConfigFormatCreate object

Parameter description:

Collection path blacklist.

1. A path must start with a slash (/) or Letter:\.

2. A path cannot contain only slashes (/). The following special characters are not allowed: <>'|".

3. A path cannot start with /** or /*.

4. Only one double asterisk (**) can be contained in a path.

Value range:

N/A.

windows_log_info

AccessConfigWindowsLogInfoCreate object

Parameter description:

Windows event logs.

Value range:

N/A.

stdout

Boolean

Parameter description:

Standard output switch. This parameter is used only for CCE log ingestion.

Value range:

N/A.

stderr

Boolean

Parameter description:

Standard error switch. This parameter is used only for CCE log ingestion.

Value range:

N/A.

pathType

String

Parameter description:

CCE log ingestion type. This parameter is used only for CCE log ingestion.

Value range:

N/A.

namespaceRegex

String

Parameter description:

Regular expression matching of Kubernetes namespaces. This parameter is used only for CCE log ingestion.

Value range:

N/A.

podNameRegex

String

Parameter description:

Regular expression matching of Kubernetes pods. This parameter is used only for CCE log ingestion.

Value range:

N/A.

containerNameRegex

String

Parameter description:

Regular expression matching of Kubernetes container names. This parameter is used only for CCE log ingestion.

Value range:

N/A.

includeLabels

Map<String,String>

Parameter description:

Container label whitelist. You can create up to 30 whitelists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

excludeLabels

Map<String,String>

Parameter description:

Container label blacklist. You can create up to 30 blacklists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

includeEnvs

Map<String,String>

Parameter description:

Environment variable whitelist. You can create up to 30 whitelists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

excludeEnvs

Map<String,String>

Parameter description:

Environment variable blacklist. You can create up to 30 blacklists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

logLabels

Map<String,String>

Parameter description:

Container label. You can create up to 30 labels. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

logEnvs

Map<String,String>

Parameter description:

Environment variable label. You can create up to 30 labels. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

includeK8sLabels

Map<String,String>

Parameter description:

Kubernetes label whitelist. You can create up to 30 whitelists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

excludeK8sLabels

Map<String,String>

Parameter description:

Kubernetes label blacklist. You can create up to 30 blacklists. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

logK8s

Map<String,String>

Parameter description:

Kubernetes label. You can create up to 30 labels. The key names must be unique. This parameter is used only for CCE log ingestion.

Value range:

N/A.

repeat_collect

Boolean

Parameter description:

Forcible repeated collection.

Value range:

N/A.

system_fields

Array of strings

Parameter description:

System built-in fields. When configuring a log ingestion rule, you can specify system fields to include in the tag data of each log reported.

The system fields for host log files are hostName, hostId, hostIP, pathFile, hostIPv6, category, collectTime, and __host_group__.

The system fields for Kubernetes cluster container log files are hostName, hostId, hostIP, pathFile, hostIPv6, clusterId, podName, appName, containerName, nameSpace, category, collectTime, __host_group__, serviceID, podIp, clusterName, workloadType, and __image_name__.

If this parameter is transferred during modification, the original configuration will be overwritten.

When you configure metadata for the first time, this parameter is mandatory and the value is ["pathFile"]. In this case, pathFile is mandatory and other fields are optional.

Value range:

N/A.

custom_key_value

Map<String,String>

Parameter description:

Custom key-value pairs. When configuring a log ingestion rule, you can configure up to 20 custom key-value pairs to include in the tag data of each log reported. A key can contain up to 128 characters, including letters, digits, hyphens (-), and underscores (_). A value can contain up to 1,024 characters.

If this parameter is transferred during modification, the original configuration will be overwritten.

Value range:

N/A.

includeLabelsLogical

String

Parameter description:

Logic for the container label whitelist to take effect. The value can be AND or OR (default). When there are multiple conditions for the container label whitelist, AND indicates that the whitelist takes effect only when all the conditions are met, and OR indicates that the whitelist takes effect when one of the conditions is met.

Value range:

N/A.

excludeLabelsLogical

String

Parameter description:

Logic for the container label blacklist to take effect. The value can be AND or OR (default). When there are multiple conditions for the container label blacklist, AND indicates that the blacklist takes effect only when all the conditions are met, and OR indicates that the blacklist takes effect when one of the conditions is met.

Value range:

N/A.

includeK8sLabelsLogical

String

Parameter description:

Logic for the Kubernetes label whitelist to take effect. The value can be AND or OR (default). When there are multiple conditions for the Kubernetes label whitelist, AND indicates that the whitelist takes effect only when all the conditions are met, and OR indicates that the whitelist takes effect when one of the conditions is met.

Value range:

N/A.

excludeK8sLabelsLogical

String

Parameter description:

Logic for the Kubernetes label blacklist to take effect. The value can be AND or OR (default). When there are multiple conditions for the Kubernetes label blacklist, AND indicates that the blacklist takes effect only when all the conditions are met, and OR indicates that the blacklist takes effect when one of the conditions is met.

Value range:

N/A.

includeEnvsLogical

String

Parameter description:

Logic for the environment variable whitelist to take effect. The value can be AND or OR (default). When there are multiple conditions for the environment variable whitelist, AND indicates that the whitelist takes effect only when all the conditions are met, and OR indicates that the whitelist takes effect when one of the conditions is met.

Value range:

N/A.

excludeEnvsLogical

String

Parameter description:

Logic for the environment variable blacklist to take effect. The value can be AND or OR (default). When there are multiple conditions for the environment variable blacklist, AND indicates that the blacklist takes effect only when all the conditions are met, and OR indicates that the blacklist takes effect when one of the conditions is met.

Value range:

N/A.

single

AccessConfigFormatSingleCreate object

Parameter description:

Single-line format is set as the log ingestion format.

Value range:

N/A.

multi

AccessConfigFormatMutilCreate object

Parameter description:

Multi-line format is set as the log ingestion format.

Value range:

N/A.

mode

String

Parameter description:

Single-line logs. The value can be system (system time) or wildcard (time wildcard).

Value range:

N/A.

value

String

Parameter description:

Log time.

If mode is system, the value is the current timestamp.

If mode is wildcard, the value is a time wildcard, which is used to match the log printing time displayed at the beginning of a log event. If the time format in a log event is 2019-01-01 23:59:59, the time wildcard is YYYY-MM-DD hh:mm:ss. If the time format in a log event is 19-1-1 23:59:59, the time wildcard is YY-M-D hh:mm:ss.

Value range:

N/A.

mode

String

Parameter description:

Single-line logs.

The value can be time (log time) or regular (regular expression).

Value range:

N/A.

value

String

Parameter description:

Log time.

If mode is regular, the value is a regular expression.

If mode is time, the value is a time wildcard, which is used to match the log printing time displayed at the beginning of a log event. If the time format in a log event is 2019-01-01 23:59:59, the time wildcard is YYYY-MM-DD hh:mm:ss. If the time format in a log event is 19-1-1 23:59:59, the time wildcard is YY-M-D hh:mm:ss.

Value range:

N/A.

categorys

Array of strings

Parameter description:

Type of Windows event logs to be collected.

The value can be Application (application system logs), System (system logs), Security (security logs), or Setup (startup logs).

Value range:

N/A.

time_offset

AccessConfigTimeOffset object

Parameter description:

Time offset for log ingestion.

Value range:

N/A.

event_level

Array of strings

Parameter description:

Event level. The value can be information, warning, error, critical, or verbose.

Value range:

N/A.

offset

Long

Parameter description:

Time offset.

When unit is day, the value ranges from 1 to 7.

When unit is hour, the value ranges from 1 to 168.

When unit is sec, the value ranges from 1 to 604,800.

Value range:

N/A.

unit

String

Parameter description:

Unit of the time offset. The value can be day, hour, or sec.

Value range:

N/A.

log_group_id

String

Parameter description:

Log group ID.

Value range:

N/A.

log_stream_id

String

Parameter description:

Log stream ID.

Value range:

N/A.

log_group_name

String

Parameter description:

Log group name.

Value range:

N/A.

log_stream_name

String

Parameter description:

Log stream name.

Value range:

N/A.

host_group_id_list

Array of strings

Parameter description:

Host group ID list.

Value range:

N/A.

key

String

Parameter description:

Tag key, which must be unique.

Constraints:

N/A.

Value range:

It can contain up to 128 characters, including only letters, digits, spaces, and special characters (_.:=+-@). Do not start or end with a space, nor start with sys.

value

String

Parameter description:

Tag value.

Value range:

It can contain up to 255 characters, including only letters, digits, spaces, and special characters (_.:=+-@).

field_name

String

Parameter description:

Field name, which must be the same as that in keys.

Value range:

N/A.

field_value

String

Parameter description:

Field value.

Value range:

N/A.

type

String

Parameter description:

Parser type.

processor_regex: regular expression

processor_split_string: delimiter

processor_json: JSON

processor_gotime: custom time type

processor_filter_regex: log filtering

processor_drop: type of fields to be deleted

processor_rename: type of fields to be modified

Value range:

N/A.

detail

Detail object

Parameter description:

Parser configuration.

Value range:

N/A.

source_key

String

Parameter description:

Custom time key field name.

Value range:

N/A.

regex

String

Parameter description:

Regular expression for parsing. This field is required for a single-line completely regular expression or a multi-line completely regular expression.

Value range:

N/A.

keys

Array of strings

Parameter description:

Field name list, which is consistent with the field_name field.

Value range:

N/A.

multi_line_regex

String

Parameter description:

First line regular expression.

Value range:

N/A.

keep_source

Boolean

Parameter description:

Whether to upload raw logs.

Value range:

N/A.

keep_source_if_parse_error

Boolean

Parameter description:

Whether to upload logs that fail to be parsed.

Value range:

N/A.

split_sep

String

Parameter description:

Delimiters.

Value range:

The maximum length of custom characters is 10 characters, and the maximum length of a custom string is 30 characters.

split_type

String

Parameter description:

Delimiter type. The value can be char (custom characters), special_char (invisible characters), or string (custom string).

Value range:

N/A.

fields

Map<String,String>

Parameter description:

List of added fields, in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] format.

Value range:

N/A.

drop_keys

Array of strings

Parameter description:

List of deleted fields.

Value range:

N/A.

source_keys

Array of strings

Parameter description:

List of source field names for renaming fields.

Value range:

N/A.

dest_keys

Array of strings

Parameter description:

List of field names that are renamed and replaced.

Value range:

N/A.

expand_depth

Integer

Parameter description:

JSON parsing depth. The value ranges from 1 (default) to 4.

Value range:

N/A.

expand_connector

String

Parameter description:

JSON parsing field name connector.

Value range:

N/A.

source_format

String

Parameter description:

Custom time format.

Value range:

N/A.

source_value

String

Parameter description:

Custom time field value.

Value range:

N/A.

set_time

Boolean

Parameter description:

Whether to enable the custom time function.

Value range:

N/A.

include

Map<String,String>

Parameter description:

A key of a log filtering whitelist rule can contain up to 256 characters, and a value can contain up to 128 characters. A key must be unique.

Value range:

N/A.

exclude

Map<String,String>

Parameter description:

A key of a log filtering whitelist rule can contain up to 256 characters, and a value can contain up to 128 characters. A key must be unique.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

Minimum characters: 8

Maximum characters: 8

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

Minimum characters: 8

Maximum characters: 8

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

200

The log ingestion list query is successful.

400

Invalid request. Modify the request based on the description in error_msg before a retry.

500

The server has received the request but encountered an internal error.