一鍵告警：產品列表
更新時間 2024-09-25 16:20:59
最近更新時間: 2024-09-25 16:20:59
分享文章
一鍵告警
一鍵告警：產品列表
接口功能介紹
此接口用于獲取一告報警支持的產品及規則初始化信息。
接口約束
無。
URI
GET /v4/monitor/alert-onekey/describe-services
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun資源池ID | 81f7728662dd11ec810800155d307d5b |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| EnablingServices | Object | 啟用中的產品 | EnablingService | |
| allServiceSeriesInitRules | Array of Objects | 各個產品的初始化規則 | ServiceSeriesInitRules | |
| allServiceEventInitRules | Array of Objects | 各個產品的初始化規則 | ServiceEventInitRules |
表EnablingService
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| series | Array of Strings | 啟用中的series產品 | ecs | |
| event | Array of Strings | 啟用中的event產品 | ecs |
表ServiceSeriesInitRules
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alertInitConfigList | Array of Objects | 初始化規則列表 | alertInitConfig | |
| service | String | 服務。取值范圍：ecs：云主機。evs：云硬盤。...詳見“[一鍵報警：產品列表]”接口返回。 | ecs |
表ServiceEventInitRules
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alertInitConfigList | Array of Objects | 初始化規則列表 | alertInitConfig | |
| service | String | 服務。取值范圍：ecs：云主機。evs：云硬盤。...詳見“[一鍵報警：產品列表]”接口返回。 | ecs |
表 alertInitConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| dimension | String | 維度。值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | disk | |
| name | String | 規則名 | cpu使用率一鍵報警 | |
| metric | String | 指標名 | cpu_util | |
| evaluationCount | Integer | 連續出現次數 | 5 | |
| operator | String | 注意：一鍵告警規則的告警類型（alarmType）為事件類型（event）時，沒有此返回參數。 此參數表示比較符： eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于 。 | eq | |
| value | String | 注意：一鍵告警規則的告警類型（alarmType）為事件類型（event）時，沒有此返回參數。 此參數表示告警閾值，可以是整數、小數或百分數格式字符串 | 20 | |
| unit | String | 單位 | % |
請求示例
請求url
/v4/monitor/alert-onekey/describe-services?regionID=81f7728662dd11ec810800155d307d5b
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"allServiceSeriesInitRules": [
{
"service": "ecs",
"alertInitConfigList": [
{
"dimension": "ecs",
"name": "【一鍵告警】cpu使用率",
"metric": "cpu_util",
"evaluationCount": 5,
"operator": "gt",
"value": "90",
"unit": ""
},
{
"dimension": "ecs",
"name": "【一鍵告警】（Agent）發送丟包率",
"metric": "network_outing_drop_rate_inband",
"evaluationCount": 5,
"operator": "gt",
"value": "0",
"unit": ""
}
]
},
{
"service": "evs",
"alertInitConfigList": [
{
"dimension": "disk",
"name": "【一鍵告警】磁盤讀請求速率",
"metric": "disk_read_requests_rate",
"evaluationCount": 5,
"operator": "gt",
"value": "3000",
"unit": ""
},
{
"dimension": "disk",
"name": "【一鍵告警】平均寫操作耗時",
"metric": "disk_write_await",
"evaluationCount": 5,
"operator": "gt",
"value": "50",
"unit": ""
}
]
},
{
"service": "cstor_sfs",
"alertInitConfigList": [
{
"dimension": "cstor_sfs",
"name": "【一鍵告警】文件系統容量使用率",
"metric": "fs_capacity_utilization",
"evaluationCount": 5,
"operator": "gt",
"value": "80",
"unit": "%"
},
{
"dimension": "cstor_sfs",
"name": "【一鍵告警】文件系統容量使用率",
"metric": "fs_capacity_utilization",
"evaluationCount": 5,
"operator": "gt",
"value": "98",
"unit": "%"
}
]
}
],
"allServiceEventInitRules": [
{
"service": "ecs",
"alertInitConfigList": [
{
"dimension": "ecs",
"name": "云主機HA遷移發生",
"metric": "migration_event_start",
"evaluationCount": 0,
"unit": ""
},
{
"dimension": "ecs",
"name": "云主機HA遷移完成",
"metric": "migration_event_complete",
"evaluationCount": 0,
"unit": ""
}
]
}
],
"EnablingServices": {
"series": [
"ecs"
],
"event": [
"ecs"
]
}
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
