調(diào)用DescribeMetricTop接口查詢指定時(shí)間段內(nèi)排序后的云產(chǎn)品時(shí)序指標(biāo)監(jiān)控?cái)?shù)據(jù)。

各云產(chǎn)品的Namespace、Orderby、Project、Metric、Period、Dimensions等參數(shù)的取值，請(qǐng)參見(jiàn)DescribeMetricMetaList或云監(jiān)控主要監(jiān)控項(xiàng)。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeMetricTop

系統(tǒng)規(guī)定參數(shù)。取值：DescribeMetricTop。
MetricName String 是 cpu_idle

監(jiān)控項(xiàng)名稱。
Namespace String 是 acs_ecs_dashboard

產(chǎn)品的數(shù)據(jù)命名空間，用于區(qū)分不同的產(chǎn)品。

命名方式：acs_產(chǎn)品名。
Orderby String 是 Average

排序字段，即按該排序字段進(jìn)行排序，此參數(shù)為必填項(xiàng)。
Dimensions String 否 [{"instanceId": "i-abcdefgh12****"}]

維度map，用于查詢指定資源的監(jiān)控?cái)?shù)據(jù)。

格式為key-value鍵值對(duì)形式的集合，常用的key-value集合為instanceId：XXXXXX。

key和value的長(zhǎng)度為1~64個(gè)字節(jié)，超過(guò)64個(gè)字節(jié)時(shí)截取前64字節(jié)。key和value的取值可包含字母、數(shù)字、點(diǎn)號(hào)（.）、短橫線（-）、下劃線（_）、正斜線（/）和反斜線（\）。

說(shuō)明 Dimensions傳入時(shí)需要使用JSON字符串表示該Map對(duì)象，必須按順序傳入。
EndTime String 否 2019-01-30 00:10:00

結(jié)束時(shí)間。支持的格式：

  • Unix時(shí)間戳：從1970年1月1日開(kāi)始所經(jīng)過(guò)的秒數(shù)。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
Express String 否 {"groupby":["userId","instanceId"]}

對(duì)查詢出的現(xiàn)有結(jié)果進(jìn)行實(shí)時(shí)計(jì)算的表達(dá)式。目前僅支持groupby（類似數(shù)據(jù)庫(kù)的groupby語(yǔ)句）。

Length String 否 1000

每頁(yè)顯示的記錄條數(shù)，用于分頁(yè)查詢，默認(rèn)值為1000。
OrderDesc String 否 False

排序方式。取值：

  • True：由小到大排序
  • False：由大到小排序
Period String 否 60

時(shí)間間隔，單位為秒。取值一般為60（1分鐘）、300（5分鐘）、900（15分鐘）。

說(shuō)明 請(qǐng)根據(jù)需要設(shè)置此參數(shù)。例如查詢一天范圍時(shí)設(shè)置Period為60，則返回1000條數(shù)據(jù)（實(shí)際存在1440，因?yàn)樽畲蠓祷刂挡怀^(guò)1000，則只返回前1000條）。如果使用Period為300，則返回288條數(shù)據(jù)。
StartTime String 否 2019-01-30 00:00:00

開(kāi)始時(shí)間。支持的格式：

  • Unix時(shí)間戳：從1970年1月1日開(kāi)始所經(jīng)過(guò)的秒數(shù)。
  • Format格式：YYYY-MM-DDThh:mm:ssZ。
說(shuō)明 開(kāi)始和結(jié)束時(shí)間執(zhí)行的是左開(kāi)右閉的模式，startTime不能等于或大于endTime。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

請(qǐng)求ID。
Code String 200

狀態(tài)碼。

說(shuō)明 狀態(tài)碼為200表示成功。
Datapoints String [{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

監(jiān)控?cái)?shù)據(jù)列表。
Period String 60

時(shí)間間隔，單位為秒。取值為60、300、900。
Message String Success

錯(cuò)誤信息。

示例

請(qǐng)求示例


http(s)://[Endpoint]/?Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&Orderby=Average
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML 格式 

<Period>60</Period>
<Datapoints>
    <order>1</order>
    <timestamp>1551687360000</timestamp>
    <userId>12345****</userId>
    <instanceId>i-2zeehst1****</instanceId>
    <Maximum>16.41</Maximum>
    <Minimum>4.66</Minimum>
    <Average>7.74</Average>
    <_count>1</_count>
</Datapoints>
<Datapoints>
    <order>2</order>
    <timestamp>1551687360000</timestamp>
    <userId>12345****</userId>
    <instanceId>i-2zefxdy2****</instanceId>
    <Maximum>15.74</Maximum>
    <Minimum>5.03</Minimum>
    <Average>7.14</Average>
    <_count>1</_count>
</Datapoints>
<RequestId>1F68A4E8-4488-48E7-9189-3E1F5165E64E</RequestId>
<Code>200</Code>

JSON 格式 

{
	"Period":"60",
	"Datapoints":[
		{
			"timestamp":1551687360000,
			"order":1,
			"_count":1,
			"Maximum":16.41,
			"userId":"12345****",
			"Minimum":4.66,
			"instanceId":"i-2zeehst1****",
			"Average":7.74
		},
		{
			"timestamp":1551687360000,
			"order":2,
			"_count":1,
			"Maximum":15.74,
			"userId":"12345****",
			"Minimum":5.03,
			"instanceId":"i-2zefxdy2****",
			"Average":7.14
		}
	],
	"RequestId":"1F68A4E8-4488-48E7-9189-3E1F5165E64E",
	"Code":"200"
}

錯(cuò)誤碼

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。