文档首页> > API参考> API> 监控> 查询指标

查询指标

分享
更新时间: 2019/08/15 10:06

功能介绍

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

URI

POST /v1/{project_id}/ams/metrics?type={type}&limit={limit}&start={start}

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

project_id

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

type

指标查询方式,通过请求体中的metricItems传递的信息进行指标查询。

limit

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

start

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

请求消息

请求参数

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

取值范围

描述

metricItems

Array

-

当URI参数中的type取值不为“inventory”时,就通过该数组传递的参数信息进行指标查询。

namespace

String

PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS等

指标命名空间

PAAS.CONTAINER:应用指标

PAAS.NODE:节点指标

PAAS.SLA:SLA指标

PAAS.AGGR:集群指标

CUSTOMMETRICS:自定义指标

dimensions

Array

-

指标维度

dimensions.name:维度名称,如clusterName、clusterId、appName、appID、deploymentName、podName、podID、containerName、containerID等。

dimensions.value:维度取值,如应用实例ID具体的值。

metricName

String

名称长度为1~255个字符

指标名称

Header说明

请求消息头(Header)如表3所示。

表3 Header说明

名称

是否必选

说明

X-Auth-Token

从IAM服务获取的用户Token。

Content-Type

指定类型为application/json。

请求示例

(通过namespace+appName+clusterName查询)

/v1/{projectId}/ams/metrics
{
    "metricItems": [
        {
            "namespace": "PAAS.CONTAINER",
            "dimensions":[
                {
                    "name":"appName",
                    "value":"demo"
                },
                {
                    "name":"clusterName",
                    "value":"test"
                }
            ]
        }
    ]
}

响应消息

响应参数

响应参数如表4所示。

表4 响应参数

参数名称

类型

描述

errorCode

String

响应码,SVCSTG_AMS_2000000代表正常返回。

errorMessage

String

响应信息描述。

metrics

Array

指标对象列表

namespace

String

名字空间

metricName

String

指标名称

unit

String

指标单位

dimensions

Array

指标维度列表

响应示例

{ 
    "errorCode": "SVCSTG_AMS_2000000", 
    "errorMessage": "success", 
    "metrics": [{ 
        "namespace": "abc", 
        "metricName": "cpuUsage", 
        "unit":"Percent", 
        "dimensions": [{ 
                    "name": "instance_id", 
                    "value": "demo1" 
        }]     
    }] 
}

状态码

  • 正常

    状态码如表5所示。

    表5 状态码

    状态码

    编码

    描述

    200

    OK

    请求响应成功。

  • 异常

    状态码如表6所示。更多状态码请见状态码

    表6 状态码

    状态码

    编码

    描述

    400

    BadRequest

    非法请求。

    建议直接修改该请求,不要重试该请求。

    401

    Unauthorized

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

    403

    Forbidden

    请求被拒绝访问。

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

    500

    InternalServerError

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

    503

    ServiceUnavailable

    被请求的服务无效。

    建议直接修改该请求,不要重试该请求。

错误码

表7 错误码

错误码

错误信息

处理措施

SVCSTG_AMS_4000101

Invalid namespace.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000102

Invalid inventoryId.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000103

ProjectId is left blank.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000105

Invalid limit.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000106

Invalid start.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000109

Invalid metricName.

请检查对应的参数是否符合要求。

SVCSTG_AMS_5030001

The Cassandra session is null.

请联系管理员解决。

如果您喜欢这篇文档,您还可以:

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区