Querying the Log Histogram
Function
This API is used to query the number of logs that contain a specified keyword. It helps you query and collect statistics on logs in a specified period, including the number of logs that contain the keyword and the reporting details of each log.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/lts/keyword-count
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details about how to obtain it, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Parameter description: User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token. Constraints: N/A. Value range: N/A. Default value: N/A. |
Content-Type |
Yes |
String |
Parameter description: Set this parameter to application/json;charset=UTF-8. Constraints: N/A. Value range: N/A. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
Yes |
String |
Parameter description: Start time for the query. Constraints: N/A. Value range: N/A. Default value: N/A. |
end_time |
Yes |
String |
Parameter description: End time for the query. Constraints: N/A. Value range: N/A. Default value: N/A. |
step_interval |
Yes |
Long |
Parameter description: Time step, in milliseconds. Recommended formula: (end_time – start_time)/1,000 x 1,000/60, where /1,000 x 1,000 means rounding to an integer.
If the calculated result is less than or equal to 1,000, the value 1,000 is used.
Constraints: N/A. Value range: Minimum value: 1000 Default value: N/A. |
group_id |
Yes |
String |
Parameter description: Log group ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
stream_id |
Yes |
String |
Parameter description: Log stream ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
key_word |
Yes |
String |
Parameter description: A keyword is a word between two adjacent delimiters. Constraints: N/A. Value range: N/A. Default value: N/A. |
is_iterative |
No |
Boolean |
Parameter description: Whether the log query is iterative. The value can be true (iterative) or false (not iterative). Constraints: N/A. Value range: N/A. Default value: false (not iterative) |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Long |
Parameter description: Number of log events. Value range: N/A. |
histogram |
String |
Parameter description: Histogram result. Value range: N/A. |
isQueryComplete |
Boolean |
Parameter description: Whether the query is complete. Value range: N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Parameter description: Error code. Value range: N/A. |
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Parameter description: Error code. Value range: N/A. |
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
Example Requests
Query a log histogram.
POST https://{endpoint}/v2/{project_id}/lts/keyword-count
{
"group_id" : "00330565-5baf-4e0d-bd16-ba0c6b951d9a",
"stream_id" : "715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
"end_time" : 1637820813605,
"start_time" : 1637817213605,
"key_word" : "test",
"step_interval" : 6000
}
Example Responses
Status code: 200
The request for querying histogram data is successful.
{
"count" : 1,
"histogram" : [ {
"num" : 1,
"startTime" : 1637821594579,
"endTime" : 1637821595000
}, {
"num" : 0,
"startTime" : 1637821654000,
"endTime" : 1637821654579
} ]
}
Status code: 400
Invalid request. Modify the request based on the description in error_msg before a retry.
{
"error_code" : "LTS.0601",
"error_msg" : "must be less than or equal to 86400000"
}
SDK Sample Code
The SDK sample code is as follows.
Query a log histogram.
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 |
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;
public class ListLogHistogramSolution {
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);
LtsClient client = LtsClient.newBuilder()
.withCredential(auth)
.withRegion(LtsRegion.valueOf("<YOUR REGION>"))
.build();
ListLogHistogramRequest request = new ListLogHistogramRequest();
QueryLogKeyWordCountRequestBody body = new QueryLogKeyWordCountRequestBody();
body.withKeyWord("test");
body.withStreamId("715cda3b-e17f-492a-a6ca-98a1ba16ad8c");
body.withGroupId("00330565-5baf-4e0d-bd16-ba0c6b951d9a");
body.withStepInterval(6000L);
body.withEndTime("1637820813605");
body.withStartTime("1637817213605");
request.withBody(body);
try {
ListLogHistogramResponse response = client.listLogHistogram(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 a log histogram.
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
.with_credentials(credentials) \
.with_region(LtsRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ListLogHistogramRequest()
request.body = QueryLogKeyWordCountRequestBody(
key_word="test",
stream_id="715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
group_id="00330565-5baf-4e0d-bd16-ba0c6b951d9a",
step_interval=6000,
end_time="1637820813605",
start_time="1637817213605"
)
response = client.list_log_histogram(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 a log histogram.
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"
lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
lts.LtsClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ListLogHistogramRequest{}
request.Body = &model.QueryLogKeyWordCountRequestBody{
KeyWord: "test",
StreamId: "715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
GroupId: "00330565-5baf-4e0d-bd16-ba0c6b951d9a",
StepInterval: int64(6000),
EndTime: "1637820813605",
StartTime: "1637817213605",
}
response, err := client.ListLogHistogram(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.
Query a log histogram.
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 |
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;
public class ListLogHistogramSolution {
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);
LtsClient client = LtsClient.newBuilder()
.withCredential(auth)
.withRegion(LtsRegion.valueOf("<YOUR REGION>"))
.build();
ListLogHistogramRequest request = new ListLogHistogramRequest();
QueryLogKeyWordCountRequestBody body = new QueryLogKeyWordCountRequestBody();
body.withKeyWord("test");
body.withStreamId("715cda3b-e17f-492a-a6ca-98a1ba16ad8c");
body.withGroupId("00330565-5baf-4e0d-bd16-ba0c6b951d9a");
body.withStepInterval(6000L);
body.withEndTime("1637820813605");
body.withStartTime("1637817213605");
request.withBody(body);
try {
ListLogHistogramResponse response = client.listLogHistogram(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 a log histogram.
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
.with_credentials(credentials) \
.with_region(LtsRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ListLogHistogramRequest()
request.body = QueryLogKeyWordCountRequestBody(
key_word="test",
stream_id="715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
group_id="00330565-5baf-4e0d-bd16-ba0c6b951d9a",
step_interval=6000,
end_time="1637820813605",
start_time="1637817213605"
)
response = client.list_log_histogram(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 a log histogram.
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"
lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
lts.LtsClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ListLogHistogramRequest{}
request.Body = &model.QueryLogKeyWordCountRequestBody{
KeyWord: "test",
StreamId: "715cda3b-e17f-492a-a6ca-98a1ba16ad8c",
GroupId: "00330565-5baf-4e0d-bd16-ba0c6b951d9a",
StepInterval: int64(6000),
EndTime: "1637820813605",
StartTime: "1637817213605",
}
response, err := client.ListLogHistogram(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 |
The request for querying histogram data is successful. |
400 |
Invalid request. Modify the request based on the description in error_msg before a retry. |
500 |
The server has received the request but encountered an internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot