Obtaining the Data Distribution Histogram

Function

This QPI is used to obtain the data distribution histogram.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/search/histograms

**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.
from	Yes	Long	Query start time.
pipe_id	Yes	String	Data pipeline ID.
query	Yes	String	Query statement.
to	Yes	Long	Query end time.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
histograms	Array of Histogram objects	Histogram.
total_count	Long	Total data records.

**Table 5** Histogram
Parameter	Type	Description
count	Long	Number of data records in the current time range.
from	Long	Start time.
to	Long	End time.

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",
  "from" : 1584883694354,
  "pipe_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "query" : "xxx",
  "to" : 1584883694654
}

Example Responses

Status code: 200

Successful.

{
  "histograms" : [ {
    "count" : 1,
    "from" : 1584883694354,
    "to" : 1584883694360
  } ],
  "total_count" : 1
}

Status Codes

Status Code	Description
200	Successful.
400	Error response.

Error Codes

See Error Codes.

Parent topic: Query and Analysis

Previous topic: Query and Analysis

Next topic: Obtaining Search Data

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot