Querying Structuring Templates

project_id

Yes

String

Parameter description:

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

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

id

No

String

Parameter description:

ID of the template to be queried. This parameter is optional. If this parameter is left empty, all custom structuring templates in the project are returned.

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.

results

Array of StructTemplateModel objects

Parameter description:

List of queried custom structuring templates.

Value range:

N/A.

project_id

String

Parameter description:

Project ID.

Value range:

N/A.

template_name

String

Parameter description:

Template name.

Value range:

Enter up to 64 characters. Do not start with a period (.) or underscore (_) or end with a period. Only letters, digits, hyphens (-), underscores, and periods are allowed.

template_type

String

Parameter description:

Template type. The value can be regex, json, split, nginx, built_in, or custom_regex.

Value range:

N/A.

demo_log

String

Parameter description:

Sample log event.

Value range:

N/A.

Minimum: 1

Maximum: 5000

demo_fields

Array of DemoField objects

Parameter description:

Fields generated after the sample log event is parsed based on the structuring configuration.

Value range:

N/A.

tag_fields

Array of TagFieldNew objects

Parameter description:

Fixed fields generated based on the log reporting channel.

Value range:

N/A.

rule

TemplateRule object

Parameter description:

Structuring method.

Value range:

N/A.

demo_label

String

Parameter description:

Tags of the sample log event.

Value range:

N/A.

create_time

Long

Parameter description:

Creation time.

Value range:

N/A.

id

String

Parameter description:

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

Value range:

N/A.

field_name

String

Parameter description:

Field name.

Value range:

Enter up to 64 characters. Do not start with a period (.) or underscore (_) or end with a period. Only letters, digits, hyphens (-), underscores, and periods are allowed.

content

String

Parameter description:

Field example.

Value range:

N/A.

type

String

Parameter description:

Field data type.

The value can be string, long, or float.

Value range:

string, float, or long

is_analysis

Boolean

Parameter description:

Whether quick analysis is enabled. If indexing is configured, the quick analysis setting specified on the Index Settings tab page is applied.

Value range:

N/A.

index

Integer

Parameter description:

Field sequence number in regular expression and delimiter methods.

Value range:

N/A.

relation

String

Parameter description:

Hierarchical relationship between fields in a multi-level JSON file.

Value range:

N/A.

user_defined_name

String

Parameter description:

Custom field alias in JSON and Nginx modes.

Value range:

Enter up to 64 characters. Do not start with a period (.) or underscore (_) or end with a period. Only letters, digits, hyphens (-), underscores, and periods are allowed.

field_name

String

Parameter description:

Field name.

Value range:

Enter up to 64 characters. Do not start with a period (.) or underscore (_) or end with a period. Only letters, digits, hyphens (-), underscores, and periods are allowed.

content

String

Parameter description:

Field example.

Value range:

N/A.

type

String

Parameter description:

Field type.

Value range:

string, float, or long

is_analysis

Boolean

Parameter description:

Whether quick analysis is enabled. If indexing is configured, the quick analysis setting specified on the Index Settings tab page is applied.

Value range:

N/A.

index

Integer

Parameter description:

Field sequence number.

Value range:

N/A.

type

String

Parameter description:

Structuring method.

Value range:

When param is set to built_in, this parameter indicates the name of the structuring template.

param

String

Parameter description:

Structuring parameters.

Value range:

regex, json, split, nginx, built_in, or custom_regex

error_code

String

Parameter description:

Error code.

Value range:

N/A.

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

200

The request is successful.

500

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