黑石内网负载均衡监控接口

最近更新时间:2019-03-21 14:23:21

1. 接口描述

域名:monitor.api.qcloud.com
接口:GetMonitorData

黑石内网负载均衡提供了获取以下四种级别监控数据的组合:
负载均衡级别,监听器级别,监听器下服务器级别,监听器下服务器端口级别。

1.1 获取负载均衡级别监控数据,入参取值如下:

namespace:qce/bm_intra_lb
dimensions.0.name=vip
dimensions.0.value 为负载均衡的 vip
dimensions.1.name=vpcId
dimensions.1.value 为负载均衡实例所属的私有网络整形 ID,可通过 查询私有网络列表 返回的字段 vpcId 获得

1.2 获取监听器级别监控数据,入参取值如下:

namespace:qce/bm_intra_lb
dimensions.0.name=vip
dimensions.0.value 为负载均衡的vip
dimensions.1.name=protocol
dimensions.1.value 为协议值,可取值(tcp,udp,http,https)
dimensions.2.name=loadBalancerPort
dimensions.2.value 为负载均衡的端口
dimensions.3.name=vpcId
dimensions.3.value 为负载均衡实例所属的私有网络整形 ID

1.3 获取监听器下服务器级别监控数据,入参取值如下:

namespace:qce/bm_intra_lb
dimensions.0.name=vip
dimensions.0.value 为负载均衡的 vip
dimensions.1.name=protocol
dimensions.1.value 为协议值,可取值(tcp,udp,http,https)
dimensions.2.name=loadBalancerPort
dimensions.2.value 为负载均衡的端口
dimensions.3.name=lanIp
dimensions.3.value 为后端服务器的 IP
dimensions.4.name=vpcId
dimensions.4.value 为负载均衡实例所属的私有网络整形 ID

1.4 获取监听器下服务器端口级别监控数据,入参取值如下:

namespace:qce/bm_intra_lb
dimensions.0.name=vip
dimensions.0.value 为负载均衡的vip
dimensions.1.name=protocol
dimensions.1.value 为协议值,可取值(tcp,udp,http,https)
dimensions.2.name=loadBalancerPort
dimensions.2.value 为负载均衡的端口
dimensions.3.name=lanIp
dimensions.3.value 为后端服务器的ip
dimensions.4.name=rsPort
dimensions.4.value 为后端服务器的端口
dimensions.5.name=vpcId
dimensions.5.value 为负载均衡实例所属的私有网络整形 ID

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 GetMonitorData。

2.1输入参数

参数名称 必选 类型 输入内容 描述
namespace String qce/bm_intra_lb 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏。
metricName String 具体的指标名称 指标名称,具体名称见2.2
dimensions.n.name String 维度的名称 维度的名称,具体维度名称见第1节,与dimensions.n.value配合使用。
dimensions.n.value String 对应的维度的值 对应的维度的值,具体维度名称见第1节,与dimensions.n.name配合使用。
period Int 60/300 监控统计周期,绝大部分指标支持60s统计粒度,部分指标仅支持300s统计粒度,统计粒度根据指标的不同而变。输入参数时可参考2.2的指标详情列表。
startTime Datetime 起始时间 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
endTime Datetime 结束时间 结束时间,默认为当前时间。 endTime不能小于startTime

2.2 指标名称

指标名称 含义 单位
inpkg 入包量 个/秒
outpkg 出包量 个/秒
intraffic 入带宽 Mbps
outtraffic 出带宽 Mbps
connum 当前连接数(四层监听器)
req 请求个数(七层监听器)

3. 输出参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值表示失败
message String 返回信息
startTime Datetime 起始时间
endTime Datetime 结束时间
metricName String 指标名称
period Int 监控统计周期
dataPoints Array 监控数据列表

4. 错误码表

错误代码 错误描述 英文描述
-502 资源不存在 OperationDenied.SourceNotExists
-503 请求参数有误 InvalidParameter
-505 参数缺失 InvalidParameter.MissingParameter
-507 超出限制 OperationDenied.ExceedLimit
-509 错误的维度组合 InvalidParameter.DimensionGroupError
-513 DB操作失败 InternalError.DBoperationFail

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/bm_intra_lb
&metricName=inpkg
&dimensions.0.name=vip
&dimensions.0.value=1.2.3.4
&dimensions.1.name=protocol
&dimensions.1.value=tcp
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=lanIp
&dimensions.3.value=11.22.33.44
&dimensions.4.name=rsPort
&dimensions.4.value=8080
&dimensions.5.name=vpcId
&dimensions.5.value=1
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "inpkg",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        20,
        30,
        40
    ]
}