接口请求参数

最近更新时间:2017-12-07 12:59:34

接口请求参数与具体的接口有关,不同的接口支持的接口请求参数也不一样。接口请求参数的首字母均为小写,以此区分于公共请求参数。
获取监控指标列表(DescribeMetrics)为例,其支持的接口请求参数如下:

参数名称 必选 类型 描述
namespace String 命名空间:一个命名空间表示某一大类资源,指定命名空间,即可获取该指定大类资源下的所有监控指标类型。目前该参数只支持填入 "qce/cvm", 用于获取云服务器下的所有监控指标类型。
metricName String 监控指标类型的名称,例如“cpu_usage","mem_usage”最小为1个字符,最大为64个字符, 如不传则返回 namespce下的所有指标列表

其中各字段的说明如下:

参数名称 该接口支持的请求参数名,用户可以在使用此接口时将其作为接口请求参数。
必选 标志此参数是否是必须的,若为“是”,则表明调用该接口必须传入此参数;若为“否”,表示可以不传入。
类型 此接口参数的数据类型。
描述 简要描述了此接口请求参数的内容。

假设用户想要获取监控指标列表,则其请求链接的形式可能如下:

 https://monitor.api.qcloud.com/v2/index.php?
 &<公共请求参数>
&namespace=qce/cvm

一个完整的请求需要两类请求参数:公共请求参数和接口请求参数。这里只列出了接口请求参数,并未列出公共请求参数,有关公共请求参数的说明可见公共请求参数小节。