調用DescribeMetricRuleTemplateList接口查詢報警模板列表。
接口說明
本文將提供一個示例,查詢報警模板列表。返回結果顯示,報警模板列表中共有 2 個報警模板,分別是ECS_Template1
和ECS_Template2
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cms:DescribeMetricRuleTemplateList | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 報警模板名稱。 | ECS_Template1 |
Keyword | string | 否 | 報警模板名稱關鍵字。 | ECS |
TemplateId | long | 否 | 報警模板 ID。 | 70**** |
PageNumber | long | 否 | 頁碼。 默認值:1。 | 1 |
PageSize | long | 否 | 每頁顯示模板的記錄條數。 | 10 |
History | boolean | 否 | 是否顯示報警模板應用到應用分組的歷史記錄。取值:
| false |
Order | boolean | 否 | 排序方式。取值:
| true |
OrderBy | string | 否 | 排序依據。取值:
| gmtCreate |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "The Request is not authorization.",
"RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
"Total": 2,
"Success": true,
"Templates": {
"Template": [
{
"Description": "ECS的CPU使用率",
"GmtCreate": 1646018798000,
"Name": "ECS_Template1",
"RestVersion": 0,
"GmtModified": 1646054798000,
"TemplateId": 0,
"ApplyHistories": {
"ApplyHistory": [
{
"GroupId": 0,
"GroupName": "ECS_Group",
"ApplyTime": 1646055898000
}
]
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-03-22 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |