文档首页 > > API参考> API> 监控>

查询时间序列

查询时间序列

分享
更新时间:2020/12/24 GMT+08:00

功能介绍

该接口用于查询系统当前可监控的时间序列列表,可以指定时间序列命名空间、名称、维度、所属资源的编号(格式为:resType_resId),分页查询的起始位置和返回的最大记录条数。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/series

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

表2 Query参数

参数

是否必选

参数类型

描述

limit

String

取值范围(0,1000],默认值为1000。用于限制本次返回的结果数据条数。

offset

String

分页查询起始位置,为非负整数。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

series

Array of QuerySeriesOptionParam objects

通过该数组传递的参数信息进行时间序列查询。

表4 QuerySeriesOptionParam

参数

是否必选

参数类型

描述

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个字符 时间序列名称。

dimensions

Array of Dimension objects

时间序列维度列表。

表5 Dimension

参数

是否必选

参数类型

描述

name

String

名称。

value

String

具体数值。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

series

Array of SeriesQueryItemResult objects

时间序列对象列表。

meta_data

MetaData object

查询结果元数据信息,包括分页信息等。

表7 SeriesQueryItemResult

参数

参数类型

描述

namespace

String

命名空间。

dimensions

Array of Dimension objects

维度列表。

metric_name

String

时间序列名称。

unit

String

时间序列单位。

dimension_value_hash

String

时间序列哈希值。

表8 Dimension

参数

参数类型

描述

name

String

名称。

value

String

具体数值。

表9 MetaData

参数

参数类型

描述

count

Integer

当前返回结果条数。

offset

String

下一个开始的标记,用于分页,null表示无更多数据。

total

Integer

总条数。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

error_type

String

错误类型。

请求示例

示例1(通过namespace+appName+clusterName查询)
/v2/{project_id}/series
{
    "series": [
        {
            "namespace": "PAAS.CONTAINER",
            "dimensions":[
                {
                    "name":"appName",
                    "value":"demo"
                },
                {
                    "name":"clusterName",
                    "value":"test"
                }
            ]
        }
    ]
}

响应示例

状态码: 200

编码 OK 请求执行完成。

{
  "meta_data" : {
    "count" : 1,
    "offset" : null,
    "total" : 1
  },
  "series" : [ {
    "namespace" : "abc",
    "metric_name" : "cpuUsage",
    "unit" : "Percent",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "demo1"
    } ]
  } ]
}

状态码: 400

编码: BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.04007500",
  "error_msg" : "internal server error",
  "error_type" : "INTERNAL_SERVER_ERROR"
}

状态码

状态码

描述

200

编码 OK 请求执行完成。

400

编码: BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

401

在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

403

编码 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

编码 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

503

编码 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。

错误码

请参见错误码

分享:

    相关文档

    相关产品