查询时间序列
功能介绍
该接口用于查询系统当前可监控的时间序列列表,可以指定时间序列命名空间、名称、维度、所属资源的编号(格式为:resType_resId),分页查询的起始位置和返回的最大记录条数。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/series
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
String |
用于限制本次返回的结果数据条数。 取值范围(0,1000],默认值为1000。 |
offset |
否 |
String |
分页查询起始位置,为非负整数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
series |
是 |
Array of QuerySeriesOptionParam objects |
通过该数组传递的参数信息进行时间序列查询。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
是 |
String |
时间序列命名空间。取值范围:PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS等。PAAS.CONTAINER:应用时间序列命名空间;PAAS.NODE:节点时间序列命名空间;PAAS.SLA:SLA时间序列命名空间;PAAS.AGGR:集群时间序列命名空间;CUSTOMMETRICS:自定义时间序列命名空间。 |
metric_name |
否 |
String |
时间序列名称,名称长度取值范围为1~255个字符。取值范围:AOM提供的基础时间序列名称,cpuUsage、cpuCoreUsed等:cpuUsage:cpu使用率;cpuCoreUsed:cpu内核占用;用户上报的自定义时间序列名称。 |
dimensions |
否 |
Array of DimensionSeries objects |
时间序列维度列表。可通过/v2/{project_id}/series接口中namespace+metric_name,查询当前监控的时间序列名称的时间序列维度列表。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
series |
Array of SeriesQueryItemResult objects |
时间序列对象列表。 |
meta_data |
MetaDataSeries object |
查询结果元数据信息,包括分页信息等。 |
参数 |
参数类型 |
描述 |
---|---|---|
namespace |
String |
命名空间。 |
dimensions |
Array of DimensionSeries objects |
维度列表。 |
metric_name |
String |
时间序列名称。 |
unit |
String |
时间序列单位。 |
dimension_value_hash |
String |
时间序列哈希值。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
当前返回结果条数。 |
offset |
Integer |
下一个开始的标记,用于分页,null表示无更多数据。 |
total |
Integer |
总条数。 |
nextToken |
Integer |
偏移量。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息描述。 |
error_type |
String |
错误类型。 |
trace_id |
String |
请求id |
请求示例
通过namespace+metric_name查询系统当前可监控的时间序列列表
https://{Endpoint}/v2/{project_id}/series { "series" : [ { "namespace" : "PAAS.CONTAINER", "metric_name" : "aom_process_cpu_usage" } ] }
响应示例
状态码: 200
OK 请求执行完成。
{ "meta_data" : { "count" : 1, "offset" : null, "total" : 1, "nextToken" : 0 }, "series" : [ { "namespace" : "PAAS.CONTAINER", "metric_name" : "cpuUsage", "unit" : "Percent", "dimensions" : [ { "name" : "appName", "value" : "appValue" } ], "dimension_value_hash" : null } ] }
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.04007101", "error_msg" : "Invalid namespace", "error_type" : "BAD_REQUEST", "trace_id" : "" }
SDK代码示例
SDK代码示例如下。
通过namespace+metric_name查询系统当前可监控的时间序列列表
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 56 57 58 |
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.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; import java.util.List; import java.util.ArrayList; public class ListSeriesSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListSeriesRequest request = new ListSeriesRequest(); request.withLimit("<limit>"); request.withOffset("<offset>"); SeriesAPIQueryItemParam body = new SeriesAPIQueryItemParam(); List<QuerySeriesOptionParam> listbodySeries = new ArrayList<>(); listbodySeries.add( new QuerySeriesOptionParam() .withNamespace("PAAS.CONTAINER") .withMetricName("aom_process_cpu_usage") ); body.withSeries(listbodySeries); request.withBody(body); try { ListSeriesResponse response = client.listSeries(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()); } } } |
通过namespace+metric_name查询系统当前可监控的时间序列列表
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.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"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSeriesRequest() request.limit = "<limit>" request.offset = "<offset>" listSeriesbody = [ QuerySeriesOptionParam( namespace="PAAS.CONTAINER", metric_name="aom_process_cpu_usage" ) ] request.body = SeriesAPIQueryItemParam( series=listSeriesbody ) response = client.list_series(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
通过namespace+metric_name查询系统当前可监控的时间序列列表
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSeriesRequest{} limitRequest:= "<limit>" request.Limit = &limitRequest offsetRequest:= "<offset>" request.Offset = &offsetRequest metricNameSeries:= "aom_process_cpu_usage" var listSeriesbody = []model.QuerySeriesOptionParam{ { Namespace: "PAAS.CONTAINER", MetricName: &metricNameSeries, }, } request.Body = &model.SeriesApiQueryItemParam{ Series: listSeriesbody, } response, err := client.ListSeries(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求执行完成。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。