調(diào)用DescribeMetricData接口查詢指定云產(chǎn)品的某個(gè)監(jiān)控項(xiàng)的監(jiān)控?cái)?shù)據(jù)。
接口說明
使用限制
單個(gè) API 的調(diào)用次數(shù)限制為 10 次/秒。一個(gè)阿里云賬號(hào)及該賬號(hào)下的 RAM 用戶共用 10 次/秒。
使用說明
Dimension={"instanceId": "i-abcdefgh12****"}
),將該賬號(hào)下的所有監(jiān)控?cái)?shù)據(jù)進(jìn)行聚合統(tǒng)計(jì)。
本文將提供一個(gè)示例,查詢云產(chǎn)品acs_ecs_dashboard
監(jiān)控項(xiàng)cpu_idle
的監(jiān)控?cái)?shù)據(jù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cms:QueryMetricData | get |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Namespace | string | 是 | 云產(chǎn)品的數(shù)據(jù)命名空間。 關(guān)于云產(chǎn)品的數(shù)據(jù)命名空間,請參見云產(chǎn)品監(jiān)控項(xiàng)。 | acs_ecs_dashboard |
MetricName | string | 是 | 云產(chǎn)品的監(jiān)控項(xiàng)名稱。 關(guān)于云產(chǎn)品的監(jiān)控項(xiàng)名稱,請參見云產(chǎn)品監(jiān)控項(xiàng)。 | cpu_idle |
Period | string | 否 | 監(jiān)控項(xiàng)的統(tǒng)計(jì)周期。 取值:15、60、900 和 3600。 單位:秒。 說明
| 60 |
StartTime | string | 否 | 查詢監(jiān)控?cái)?shù)據(jù)的開始時(shí)間。
開始時(shí)間支持的格式:
說明
StartTime 如果設(shè)置過早,則無效。
| 1618368900000 |
EndTime | string | 否 | 查詢監(jiān)控?cái)?shù)據(jù)的結(jié)束時(shí)間。
結(jié)束時(shí)間支持的格式:
說明
建議您使用 Unix 時(shí)間戳,避免時(shí)區(qū)的問題。
| 1618368960000 |
Dimensions | string | 否 | 維度 Map,用于查詢指定資源的監(jiān)控?cái)?shù)據(jù)。 格式:key-value 鍵值對形式的集合,常用的 key-value 集合為 說明
單次請求最多支持批量查詢 50 個(gè)實(shí)例。
| [{"instanceId": "i-abcdefgh12****"}] |
Express | string | 否 | 對查詢出的現(xiàn)有結(jié)果進(jìn)行實(shí)時(shí)計(jì)算的表達(dá)式。 說明
目前僅支持 groupby (類似數(shù)據(jù)庫groupby 語句)。
| {"groupby":["userId","instanceId"]} |
Length | string | 否 | 每頁顯示的記錄條數(shù),用于分頁查詢。 默認(rèn)值:1000。 說明
單次請求 Length 的最大值為 1440。
| 1000 |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "The specified resource is not found.",
"RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
"Datapoints": "[{\\\"timestamp\\\":1618368900000,\\\"Average\\\":95.8291666666667,\\\"Minimum\\\":65.48,\\\"Maximum\\\":100.0},{\\\"timestamp\\\":1618368960000,\\\"Average\\\":95.8683333333333,\\\"Minimum\\\":67.84,\\\"Maximum\\\":100.0}]",
"Period": "60"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | ParameterInvalid | Illegal parameters. | - |
403 | AccessForbidden | User not authorized to operate on the specified resource. | - |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定資源。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-01-23 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |