基本信息

Action

DescribeAlarms

Path

/iaas

Method

GET

请求参数

此接口除公共参数外，还包含以下参数。关于公共参数的更多信息，请参见前文内容。

参数名 类型 是否必须 描述

alarm_policy_category

String

否

告警策略类型

alarms

Array

否

告警ID 数组

owner

String

是

用户 ID

policy_usage

String

否

告警策略用途

resource_id

String

否

资源 ID，以英文逗号分隔

resource_type

String

否

资源类型

reverse

Integer

否

是否逆序

sort_key

String

否

排序字段名称

status

Array

否

告警状态

verbose

String

否

是否返回告警关联资源信息

返回数据

此接口除公共返回参数外，还包含以下返回参数。关于公共返回参数的更多信息，请参见前文内容。

参数名 类型 是否必须 描述

alarm_set

Object

否

告警信息

alarm_set.alarm_id

String

否

告警Id

alarm_set.console_id

String

否

Console ID

alarm_set.controller

String

否

控制器

alarm_set.create_time

String

否

创建时间

alarm_set.owner

String

否

用户 ID

alarm_set.policy

Object

否

告警策略详情

alarm_set.policy.alarm_policy_category

String

否

告警策略类型

alarm_set.policy.alarm_policy_id

String

否

告警策略 ID

alarm_set.policy.alarm_policy_name

String

否

告警策略名称

alarm_set.policy.alarm_policy_type

String

否

告警策略类型

alarm_set.policy.create_time

String

否

创建时间

alarm_set.policy.description

String

否

描述

alarm_set.policy.is_applied

Integer

否

是否应用

alarm_set.policy.notice_count

Integer

否

通知次数

alarm_set.policy.operator

String

否

操作

alarm_set.policy.owner

String

否

用户 ID

alarm_set.policy.period

String

否

监控周期

alarm_set.policy.resource_info

String

否

资源信息

alarm_set.policy.status

String

否

策略状态

alarm_set.policy.status_time

String

否

创建时间

alarm_set.policy.sub_code

Integer

否

子编码

alarm_set.policy.usage

String

否

用途

alarm_set.reason

String

否

告警原因

alarm_set.related_resource

String

否

关联资源 ID

alarm_set.resource

Object

否

资源信息

alarm_set.resource.resource_id

String

否

资源 ID

alarm_set.resource.resource_name

String

否

资源名称

alarm_set.resource.resource_type

String

否

资源类型

alarm_set.root_user_id

String

否

root用户 ID

alarm_set.rules

Object

否

告警规则

alarm_set.rules.alarm_level_id

String

否

规则级别

alarm_set.rules.alarm_policy_id

String

否

告警策略 ID

alarm_set.rules.alarm_policy_rule_id

String

否

规则 ID

alarm_set.rules.alarm_policy_rule_name

String

否

规则名称

alarm_set.rules.condition_type

String

否

条件

alarm_set.rules.consecutive_count

String

否

连续次数

alarm_set.rules.consecutive_periods

Integer

否

连续周期

alarm_set.rules.create_time

String

否

创建时间

alarm_set.rules.data_processor

String

否

数据类型

alarm_set.rules.disabled

Integer

否

是否禁用

alarm_set.rules.event_total_count

String

否

事件总数

alarm_set.rules.meter

String

否

规则指标

alarm_set.rules.owner

String

否

用户 ID

alarm_set.rules.period_end_hhmm

String

否

规则生效截至时间

alarm_set.rules.period_start_hhmm

String

否

规则生效开始时间

alarm_set.rules.status

String

否

规则状态

alarm_set.rules.thresholds

String

否

阈值

alarm_set.status

String

否

告警状态

alarm_set.update_time

String

否

更新时间

alarm_set.used_notice_count

Integer

否

通知次数

total_count

Integer

否

告警信息总条数

trace_id

String

否

追踪 ID

请求示例

{
  "action": "DescribeAlarms",
  "limit": 10,
  "offset": 0,
  "owner": "usr-jdxUgG5s",
  "policy_usage": "alarm",
  "reverse": 1,
  "sort_key": "update_time",
  "status": [
    "alarm"
  ],
  "zone": "testing"
}

返回示例

{
  "action": "DescribeAlarmsResponse",
  "alarm_set": [
    {
      "alarm_id": "alm-7cxj5qpy",
      "alarm_policy_id": "alp-x78shdsa",
      "console_id": "testingcloud",
      "controller": "self",
      "create_time": "2023-05-11T07:10:38Z",
      "owner": "usr-jdxUgG5s",
      "reason": "unhealthy||0",
      "related_resource": "",
      "resource": {
        "loadbalancer": {
          "loadbalancer_id": "lb-327k8q2r"
        },
        "resource_id": "lbl-0sg9klyw",
        "resource_name": "cloudsat",
        "resource_type": "loadbalancer_listener"
      },
      "root_user_id": "usr-jdxUgG5s",
      "status": "alarm",
      "update_time": "2023-05-26T06:56:12Z",
      "used_notice_count": 1
    }
  ],
  "ret_code": 0,
  "total_count": 1
}