按时间段统计查询资源
功能介绍
按时间段统计查询资源。支持按自定义时间区间对资源进行查询统计,统计结果用于资源监控、异常流量定位分析等,帮助您进行实时流量统计和数据回溯。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/lts/timeline-traffic-statistics
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
timezone |
是 |
String |
参数解释: 时区,例如:Asia/Shanghai、Europe/Paris、Africa/Cairo等。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token,获取方式请参见:获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 用于定义消息体的格式,该字段填为:application/json;charset=utf8。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
是 |
Long |
参数解释: 按照时间范围查询日志的起始时间,时间戳(秒级)。 参数start_time和end_time组成的时间区间,既包含起始时间也包含结束时间。 约束限制:
取值范围: 毫秒级时间戳,表示从1970-1-1 00:00:00 UTC开始计算的毫秒数。 默认取值: 不涉及。 |
end_time |
是 |
Long |
参数解释: 按照时间范围查询日志的结束时间,时间戳(秒级)。 参数start_time和end_time组成的时间区间,既包含起始时间也包含结束时间。 约束限制:
取值范围: 毫秒级时间戳,表示从1970-1-1 00:00:00 UTC开始计算的毫秒数。 默认取值: 不涉及。 |
period |
是 |
Integer |
参数解释: 查询时间范围的间隔(小时)。 约束限制: 不涉及。 取值范围: 1~24小时。 默认取值: 不涉及。 |
resource_type |
是 |
String |
参数解释: 查询的资源类型。支持三种资源类型: log_group:日志组。 log_stream:日志流。 Tenant:租户级别。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
search_type |
是 |
String |
参数解释: 查询流量的类型。 约束限制: 不涉及。 取值范围: wite:读写。 inex:索引。 sorage:存储。 basicTransfer:基础转储。 seniorTransfer:高级转储。 coldStorage:冷存储量。 默认取值: 不涉及。 |
resource_id |
否 |
String |
参数解释: 资源ID。不同的资源类型(resource_type),资源ID不同。
约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
results |
Array of Resulits objects |
参数解释: 按时间段查询的资源结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
timestamp |
Long |
参数解释: 查询该时间段内的日志时间戳。 取值范围: 不涉及。 |
value |
Double |
参数解释: 对应时间戳的日志流量。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
errorCode |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
errorMessage |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
errorCode |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
errorMessage |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
请求示例
按时间段统计查询资源。
v2/{project_id}/lts/timeline-traffic-statistics?timezone=Asia/Shanghai
{
"start_time" : 1668614400000,
"end_time" : 1668787200000,
"search_type" : "write",
"period" : 1,
"resource_type" : "tenant"
}
响应示例
状态码:200
查询资源成功。
{
"results" : [ {
"timestamp" : 1669046400000,
"value" : 8.24859442E7
}, {
"timestamp" : 1669071600000,
"value" : 0
}, {
"timestamp" : 1669161600000,
"value" : 9.06895742E7
}, {
"timestamp" : 1669215600000,
"value" : 8.81524816E7
} ]
}
状态码:400
非法请求,建议根据error_msg直接修改该请求。
{
"errorCode" : "LTS.0009",
"errorMessage" : "resource_id must not be empty"
}
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{
"errorCode" : "LTS.0203",
"errorMessage" : "Internal Server Error"
}
SDK代码示例
SDK代码示例如下。
按时间段统计查询资源。
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());
}
}
}
|
按时间段统计查询资源。
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)
|
按时间段统计查询资源。
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
按时间段统计查询资源。
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());
}
}
}
|
按时间段统计查询资源。
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)
|
按时间段统计查询资源。
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询资源成功。 |
400 |
非法请求,建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。