You need to enable JavaScript to run this app.
导航
PostApiV1AlarmDescribeOverview - 获取告警概览
最近更新时间:2024.11.06 17:01:31首次发布时间:2024.11.06 17:01:31

获取多云-告警顶部的告警统计数据,包括:未处理级别分布统计、告警状态分布统计。

请求说明

  • 请求方式: POST
  • 请求地址: https://open.volcengineapi.com/?Action=PostApiV1AlarmDescribeOverview&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

PostApiV1AlarmDescribeOverview

要执行的操作,取值:PostApiV1AlarmDescribeOverview。

Version
String

2023-05-01

API的版本,取值:2023-05-01。

cloud_account_list
Array of Object

--

云账号列表

resource_cloud_vendor_list
Array of String

[
"volcengine",
"aliyun",
"tencent"
]

资源云厂商列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
alarm_stat_overview
Object

--

接口请求结果

请求示例

POST /?Action=PostApiV1AlarmDescribeOverview&Version=2023-05-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241105T033800Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/mcs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "cloud_account_list": [
    {
      "resource_vendor": "volcengine",
      "resource_cloud_account_id": "900000000123"
    }
  ],
  "resource_cloud_vendor_list": [
    "volcengine",
    "aliyun",
    "tencent"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202411051138221022542510602A48A9",
    "Action": "PostApiV1AlarmDescribeOverview",
    "Version": "2023-05-01",
    "Service": "mcs",
    "Region": "cn-beijing"
  },
  "Result": {
    "alarm_stat_overview": {
      "status_overview": {
        "handled": 10,
        "unhandled": 10,
        "whitened": 10,
        "ignored": 10,
        "total": 40
      },
      "unhandled": {
        "critical": 10,
        "high": 10,
        "medium": 10,
        "low": 10,
        "security": 10,
        "total": 50
      }
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter %s is invalid.

无效参数

400
OperationDenied
Operation is denied because the specified resource is in use.

操作被拒绝

400
MissingParameter
The required parameter %s is missing.

缺失参数

500
InternalError
The request has failed due to an unknown error.

内部错误