Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Monitoring/ Obtaining Metric Statistics
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Metric Statistics

Function

This API is used to obtain metric statistics.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/moniter/metric/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

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace 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

dataspace_id

Yes

String

Data space ID.

end_timestamp

Yes

Long

End time.

pipe_id

Yes

String

Data pipeline ID.

start_timestamp

Yes

Long

Start time.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of Result objects

Data point.
Table 5 Result

Parameter

Type

Description

average_msg_bytes

Number

Average consumption size.

subscribe_msgs

Long

Number of consumption records.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

{
  "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
  "end_timestamp" : 1584883694954,
  "pipe_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "start_timestamp" : 1584883694954
}

Example Responses

Status code: 200

Successful.

{
  "result" : [ {
    "average_msg_bytes" : 4588.3,
    "subscribe_msgs" : 591492
  } ]
}

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.

Parent topic: Monitoring