一键告警
一键告警：产品列表
接口功能介绍
此接口用于获取一告报警支持的产品及规则初始化信息。
接口约束
无。
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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
