Updated on 2026-02-05 GMT+08:00

Querying Table Logs

Function

This API is used to query table logs.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/logs

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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

table_id

Yes

String

Table ID.

Request Parameters

Table 2 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

query

Yes

String

Retrieval query criteria. For details about the syntax, see the help documentation.

from

No

Integer

Timestamp, in ms.

to

No

Integer

Timestamp, in ms.

limit

Yes

Long

Number of records on each page.

offset

No

Long

Page number.

script_params

No

Array of SearchScriptParam objects

Script parameters.

Table 4 SearchScriptParam

Parameter

Mandatory

Type

Description

key

No

String

Key.

value

No

String

Value.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

schema

Array of SearchQueryField objects

Query result schema.

datarows

Array<Array<>>

Query result row.

total

Integer

Total count of results

size

Integer

Returned count of results

results

Array of SearchQueryResult objects

Results in JSON format

Table 6 SearchQueryField

Parameter

Type

Description

name

String

Field name.

type

String

Definition

Data type.

  • boolean: boolean data

  • byte: byte data

  • short: short integer

  • integer: integer data

  • long: long integer

  • float: single-precision floating point

  • half_float: half-precision floating point

  • scaled_float: scaling floating point

  • double: double-precision floating point

  • keyword: keyword data

  • text: text data

  • date: date data

  • ip: IP addresses

  • binary: binary data

  • object: object data

  • nested: nested data

Constraints

N/A

Range

  • boolean

  • byte

  • short

  • integer

  • long

  • float

  • half_float

  • scaled_float

  • double

  • keyword

  • text

  • date

  • ip

  • binary

  • object

  • nested

Default Value

N/A

alias

String

Field alias.

Table 7 SearchQueryResult

Parameter

Type

Description

timestamp

String

Timestamp.

data_source

Object

Data source.

Example Requests

Query table logs.

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/logs

{
  "query" : "",
  "from" : 1768459180121,
  "to" : 1768460080121,
  "limit" : 500,
  "offset" : 0
}

Example Responses

Status code: 200

Queried logs returned.

{
  "datarows" : [ ],
  "results" : [ ],
  "schema" : [ {
    "name" : "enterpriseProjectId",
    "type" : "text"
  }, {
    "name" : "occurTime",
    "type" : "long"
  }, {
    "name" : "hostUuid",
    "type" : "text"
  }, {
    "name" : "cloudId",
    "type" : "text"
  }, {
    "name" : "ipList",
    "type" : "text"
  }, {
    "name" : "alarmCsn",
    "type" : "text"
  }, {
    "name" : "__time",
    "type" : "date"
  }, {
    "name" : "hostIp",
    "type" : "text"
  }, {
    "name" : "alarmKey",
    "type" : "text"
  }, {
    "name" : "region",
    "type" : "text"
  }, {
    "name" : "projectId",
    "type" : "text"
  }, {
    "name" : "hostName",
    "type" : "text"
  }, {
    "name" : "severity",
    "type" : "long"
  }, {
    "name" : "alarmVersion",
    "type" : "text"
  }, {
    "name" : "agentUuid",
    "type" : "text"
  }, {
    "alias" : "",
    "name" : "dest_asset",
    "type" : "text"
  }, {
    "alias" : "",
    "name" : "ops",
    "type" : "text"
  }, {
    "alias" : "",
    "name" : "dest_asset.domain",
    "type" : "text"
  }, {
    "alias" : "",
    "name" : "appendInfo",
    "type" : "text"
  } ],
  "size" : 0,
  "total" : 0
}

SDK Sample Code

The SDK sample code is as follows.

Query table logs.

 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
49
50
51
52
53
54
55
56
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.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class ListTableLogsSolution {

    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();
        ListTableLogsRequest request = new ListTableLogsRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withTableId("{table_id}");
        ListTableLogsRequestBody body = new ListTableLogsRequestBody();
        body.withOffset(0L);
        body.withLimit(500L);
        body.withTo(1768460080121L);
        body.withFrom(1768459180121L);
        body.withQuery("");
        request.withBody(body);
        try {
            ListTableLogsResponse response = client.listTableLogs(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());
        }
    }
}

Query table logs.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 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 = ListTableLogsRequest()
        request.workspace_id = "{workspace_id}"
        request.table_id = "{table_id}"
        request.body = ListTableLogsRequestBody(
            offset=0,
            limit=500,
            to=1768460080121,
            _from=1768459180121,
            query=""
        )
        response = client.list_table_logs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Query table logs.

 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
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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.ListTableLogsRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.TableId = "{table_id}"
	offsetListTableLogsRequestBody:= int64(0)
	toListTableLogsRequestBody:= int64(1768460080121)
	fromListTableLogsRequestBody:= int64(1768459180121)
	request.Body = &model.ListTableLogsRequestBody{
		Offset: &offsetListTableLogsRequestBody,
		Limit: int64(500),
		To: &toListTableLogsRequestBody,
		From: &fromListTableLogsRequestBody,
		Query: "",
	}
	response, err := client.ListTableLogs(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

Queried logs returned.

Error Codes

See Error Codes.