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

Obtaining Monitoring Statistics

Function

This API is used to obtain monitoring statistics.

Calling Method

For details, see Calling APIs.

URI

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

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

start_timestamp

No

Integer

Timestamp, in ms.

end_timestamp

No

Integer

Timestamp, in ms.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

es_result

EsMonitorBody object

Monitoring result.

result

Array of Map<String,Object> objects

Result list returned by Pulsar.

Table 5 EsMonitorBody

Parameter

Type

Description

domain_id

String

Tenant ID.

project_id

String

Project ID.

workspace_id

String

Workspace ID.

dataspace_id

String

Data space ID.

pipe_id

String

Pipeline ID.

storage_bytes

Long

Storage bytes.

storage_count

Long

Number of stored records.

Example Requests

Obtain monitoring statistics.

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

{
  "start_timestamp" : 1765782622000,
  "end_timestamp" : 1768461022000
}

Example Responses

Status code: 200

Successful.

{
  "result" : [ {
    "record" : {
      "subscribe_msgs" : 0,
      "increment_index_docs_count" : 0,
      "topic_subscribe_rate_in_bytes" : 0,
      "pipe_id" : "2377ba26-6d90-4c90-aa24-0d9874fc9ba1",
      "produce_msgs" : 0,
      "table_id" : "fb5fa744-bf09-40a4-be82-8cebd8a2df1d",
      "domain_id" : "0996e744f600f3180f34c014f001b7c0",
      "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155",
      "backlog_bytes" : 0,
      "index_storage_bytes" : 1212486835,
      "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
      "subscription_status" : [ ],
      "topic_produce_rate_in_bytes" : 0,
      "topic_produce_rate_in_msgs" : 0,
      "topic_subscribe_rate_in_msgs" : 0,
      "__time" : "2026-01-14 15:15:01.367",
      "index_record_time" : "2026-01-14T15:15:01+08:00",
      "average_msg_bytes" : 0,
      "storage_bytes" : 1212486835,
      "increment_index_storage_bytes" : 0,
      "subscribe_bytes" : 0,
      "index_docs_count" : 341904,
      "producer_status_list" : [ ],
      "increment_subscribe_bytes" : 0,
      "pipe_name" : "sec_hss_vul",
      "category" : "INDEX",
      "record_time" : 1768374901366,
      "produce_bytes" : 0,
      "offloaded_storage_bytes" : 0
    }
  }, {
    "record" : {
      "subscribe_msgs" : 0,
      "increment_index_docs_count" : 0,
      "topic_subscribe_rate_in_bytes" : 0,
      "pipe_id" : "2377ba26-6d90-4c90-aa24-0d9874fc9ba1",
      "produce_msgs" : 0,
      "table_id" : "fb5fa744-bf09-40a4-be82-8cebd8a2df1d",
      "domain_id" : "0996e744f600f3180f34c014f001b7c0",
      "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155",
      "backlog_bytes" : 0,
      "index_storage_bytes" : 1212486835,
      "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
      "subscription_status" : [ ],
      "topic_produce_rate_in_bytes" : 0,
      "topic_produce_rate_in_msgs" : 0,
      "topic_subscribe_rate_in_msgs" : 0,
      "__time" : "2026-01-14 15:30:01.966",
      "index_record_time" : "2026-01-14T15:30:01+08:00",
      "average_msg_bytes" : 0,
      "storage_bytes" : 1212486835,
      "increment_index_storage_bytes" : 0,
      "subscribe_bytes" : 0,
      "index_docs_count" : 341904,
      "producer_status_list" : [ ],
      "increment_subscribe_bytes" : 0,
      "pipe_name" : "sec_hss_vul",
      "category" : "INDEX",
      "record_time" : 1768375801965,
      "produce_bytes" : 0,
      "offloaded_storage_bytes" : 0
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Obtain monitoring statistics.

 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
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 ShowMonitorStatsSolution {

    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();
        ShowMonitorStatsRequest request = new ShowMonitorStatsRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withTableId("{table_id}");
        ShowPulsarMonitorStatsBody body = new ShowPulsarMonitorStatsBody();
        body.withEndTimestamp(1768461022000L);
        body.withStartTimestamp(1765782622000L);
        request.withBody(body);
        try {
            ShowMonitorStatsResponse response = client.showMonitorStats(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());
        }
    }
}

Obtain monitoring statistics.

 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
# 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 = ShowMonitorStatsRequest()
        request.workspace_id = "{workspace_id}"
        request.table_id = "{table_id}"
        request.body = ShowPulsarMonitorStatsBody(
            end_timestamp=1768461022000,
            start_timestamp=1765782622000
        )
        response = client.show_monitor_stats(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Obtain monitoring statistics.

 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
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.ShowMonitorStatsRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.TableId = "{table_id}"
	endTimestampShowPulsarMonitorStatsBody:= int64(1768461022000)
	startTimestampShowPulsarMonitorStatsBody:= int64(1765782622000)
	request.Body = &model.ShowPulsarMonitorStatsBody{
		EndTimestamp: &endTimestampShowPulsarMonitorStatsBody,
		StartTimestamp: &startTimestampShowPulsarMonitorStatsBody,
	}
	response, err := client.ShowMonitorStats(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.