Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Querying the Collection Parser Template List
Updated on 2026-02-05 GMT+08:00

Querying the Collection Parser Template List

Function

This API is used to query the list of collection parser templates.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/collector/logstash/parsers/templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

title

No

String

Parser title.

description

No

String

Parser description.

offset

No

Long

Page number.

limit

No

Long

Number of records on each page.

sort_key

No

String

Sorting field.

sort_dir

No

String

Definition

Directory sorting.

  • asc: ascending order

  • desc: descending order

Constraints

N/A

Range

  • asc

  • desc

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Count.

records

Array of ParserTemplate objects

Description.

Table 5 ParserTemplate

Parameter

Type

Description

description

String

Description.

parser_id

String

UUID

title

String

Related title.

Example Requests

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/collector/logstash/parsers/templates

Example Responses

Status code: 200

Successful.

{
  "count" : 11,
  "records" : [ {
    "description" : "AWS ALB log",
    "parser_id" : "aa598ec2-a0ad-42cd-91c0-bba2a0cdf0d8",
    "title" : "AWS ALB log"
  }, {
    "description" : "Nginx log analysis",
    "parser_id" : "7d9c9eda-9dc8-4551-ad9d-8e750395a846",
    "title" : "Nginx log analysis"
  }, {
    "description" : "Analysis of LTS (LTS FLOW) log",
    "parser_id" : "89630cfd-6a8e-45c7-8ead-146b6ae61b23",
    "title" : "Analysis of LTS (LTS FLOW) log"
  }, {
    "description" : "Analysis of Anheng tamper-proof log",
    "parser_id" : "4b1e289a-81b1-4ad4-aefc-f0081c655816",
    "title" : "Analysis of Anheng tamper-proof log"
  }, {
    "description" : "Analysis of Netherhead Host Security Log",
    "parser_id" : "ba81bbb0-0469-46d9-8e0c-b16cd2086cf9",
    "title" : "Analysis of Netherhead Host Security Log"
  }, {
    "description" : "Analysis of Zhongchuang Anti-tampering Log",
    "parser_id" : "aec160e5-051c-4dc4-ac98-c7275cfdd552",
    "title" : "Analysis of Zhongchuang Anti-tampering Log"
  }, {
    "description" : "Analysis of Anheng WAF log",
    "parser_id" : "cf3570a5-a195-4550-b796-7d2bcdd2897e",
    "title" : "Analysis of Anheng WAF log"
  }, {
    "description" : "Analysis of Audit Log in Anheng Database",
    "parser_id" : "03c247a2-d346-4033-b849-420460d4b539",
    "title" : "Analysis of Audit Log in Anheng Database"
  }, {
    "description" : "Analysis of Anheng Audit Log",
    "parser_id" : "a03d08c7-4eff-46d1-a63c-97f4cd3a1ae6",
    "title" : "Analysis of Anheng Audit Log"
  }, {
    "description" : "Analysis of euleros system log",
    "parser_id" : "49304666-bc4f-4140-9769-3704c726ebb7",
    "title" : "Analysis of euleros system log"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class ListCollectorParserTemplateSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCollectorParserTemplateRequest request = new ListCollectorParserTemplateRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListCollectorParserTemplateResponse response = client.listCollectorParserTemplate(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCollectorParserTemplateRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_collector_parser_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCollectorParserTemplateRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListCollectorParserTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.