Help Center/ Log Tank Service/ API Reference/ APIs/ Log Management/ Querying Resources by Time Segment
Updated on 2025-08-21 GMT+08:00

Querying Resources by Time Segment

Function

This API is used to query resources within a custom time range. The results are useful for monitoring resources, analyzing abnormal traffic, collecting real-time traffic statistics, and backtracking data.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/lts/timeline-traffic-statistics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

timezone

Yes

String

Definition

Time zone, for example, Asia/Shanghai, Europe/Paris, or Africa/Cairo.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body format. Set this parameter to application/json;charset=utf8.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

start_time

Yes

Long

Definition

Start time for querying logs by time range. The value is a timestamp in seconds.

The time range between start_time and end_time includes both the start time and end time.

Constraints

  • The maximum time range for a query is 30 days.

  • The values of start_time and end_time must be different.

Range

The value must be a timestamp, measured in milliseconds from January 1, 1970, 00:00:00 UTC.

Default Value

N/A

end_time

Yes

Long

Definition

End time for querying logs by time range. The value is a timestamp in seconds.

The time range between start_time and end_time includes both the start time and end time.

Constraints

  • The maximum time range for a query is 30 days.

  • The values of start_time and end_time must be different.

Range

The value must be a timestamp, measured in milliseconds from January 1, 1970, 00:00:00 UTC.

Default Value

N/A

period

Yes

Integer

Definition

Interval between two query time ranges, in hours.

Constraints

N/A

Range

1 to 24 hours

Default Value

N/A

resource_type

Yes

String

Definition

Type of the resource to be queried. The options are as follows:

log_group: log group

log_stream: log stream

Tenant: tenant-level

Constraints

N/A

Range

  • log_group

  • log_stream

  • tenant

Default Value

N/A

search_type

Yes

String

Definition

Type of the traffic to be queried.

Constraints

N/A

Range

  • write: read and write

  • index

  • storage

  • basicTransfer: basic transfer

  • seniorTransfer: advanced transfer

  • coldStorage: cold storage

Default Value

N/A

resource_id

No

String

Definition

Resource ID. It varies depending on the resource type.

  • When the resource type is set to log_group, resource_id indicates the log group ID.

  • When the resource type is set to log_stream, resource_id indicates the log stream ID.

  • When the resource type is set to tenant, resource_id should be left empty.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

results

Array of Resulits objects

Definition

Resource result queried by time range.

Table 6 Resulits

Parameter

Type

Description

timestamp

Long

Definition

Log timestamp within the query time range.

Range

N/A

value

Double

Definition

Log traffic of the timestamp.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

errorCode

String

Definition

Error code. For details, see Error Codes.

Range

N/A

errorMessage

String

Definition

Error message.

Range

N/A

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

errorCode

String

Definition

Error code. For details, see Error Codes.

Range

N/A

errorMessage

String

Definition

Error message.

Range

N/A

Example Requests

Query resources by time segment.

v2/{project_id}/lts/timeline-traffic-statistics?timezone=Asia/Shanghai

{
  "start_time" : 1668614400000,
  "end_time" : 1668787200000,
  "search_type" : "write",
  "period" : 1,
  "resource_type" : "tenant"
}

Example Responses

Status code: 200

Query succeeded.

{
  "results" : [ {
    "timestamp" : 1669046400000,
    "value" : 8.24859442E7
  }, {
    "timestamp" : 1669071600000,
    "value" : 0
  }, {
    "timestamp" : 1669161600000,
    "value" : 9.06895742E7
  }, {
    "timestamp" : 1669215600000,
    "value" : 8.81524816E7
  } ]
}

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "errorCode" : "LTS.0009",
  "errorMessage" : "resource_id must not be empty"
}

Status code: 500

The server has received the request but encountered an internal error.

{
  "errorCode" : "LTS.0203",
  "errorMessage" : "Internal Server Error"
}

SDK Sample Code

The SDK sample code is as follows.

Query resources by time segment.

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

    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();
        ListTimeLineTrafficStatisticsRequest request = new ListTimeLineTrafficStatisticsRequest();
        TimelineTrafficStatisticsRequestBody body = new TimelineTrafficStatisticsRequestBody();
        body.withSearchType("write");
        body.withResourceType("tenant");
        body.withPeriod(1);
        body.withEndTime(1668787200000L);
        body.withStartTime(1668614400000L);
        request.withBody(body);
        try {
            ListTimeLineTrafficStatisticsResponse response = client.listTimeLineTrafficStatistics(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 resources by time segment.

 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
# 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 = ListTimeLineTrafficStatisticsRequest()
        request.body = TimelineTrafficStatisticsRequestBody(
            search_type="write",
            resource_type="tenant",
            period=1,
            end_time=1668787200000,
            start_time=1668614400000
        )
        response = client.list_time_line_traffic_statistics(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 resources by time segment.

 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
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.ListTimeLineTrafficStatisticsRequest{}
	request.Body = &model.TimelineTrafficStatisticsRequestBody{
		SearchType: "write",
		ResourceType: "tenant",
		Period: int32(1),
		EndTime: int64(1668787200000),
		StartTime: int64(1668614400000),
	}
	response, err := client.ListTimeLineTrafficStatistics(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

Query succeeded.

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.