你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Alerts - Get By Id

获取特定警报。
获取与特定警报相关的信息

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}?api-version=2023-07-12-preview

URI 参数

名称 必需 类型 说明
alertId
path True

string

警报实例的唯一 ID。

scope
path True

string

此处的范围是为其创建警报的 resourceId。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

alert

没问题。 返回具有指定 ID 的警报。

Other Status Codes

errorResponse

描述操作失败原因的错误响应。

示例

GetById

Sample Request

GET https://management.azure.com/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100?api-version=2023-07-12-preview

Sample Response

{
  "properties": {
    "essentials": {
      "severity": "Sev3",
      "signalType": "Log",
      "alertState": "Acknowledged",
      "monitorCondition": "Fired",
      "monitorService": "Application Insights",
      "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
      "targetResourceName": "servicedeskappinsight",
      "targetResourceGroup": "servicedeskresourcegroup",
      "targetResourceType": "components",
      "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
      "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
      "smartGroupingReason": "Occurred frequently with other alerts",
      "alertRule": "https://sersdfsdfinsight.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
      "startDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedDateTime": "2018-09-13T15:51:02Z",
      "lastModifiedUserName": "System",
      "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
      "actionStatus": {
        "isSuppressed": false
      },
      "description": "description of the alert"
    },
    "egressConfig": {},
    "context": {}
  },
  "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
  "type": "Microsoft.AlertsManagement/alerts",
  "name": "cpu alert"
}

定义

名称 说明
actionStatus

操作状态

alert

在警报管理服务中创建的警报。

alertProperties

警报属性包

AlertState

警报对象状态,可由用户修改。

errorResponse

来自服务的错误响应。

errorResponseBody

错误响应的详细信息。

essentials

此对象包含跨不同监视服务的一致字段。

MonitorCondition

监视服务中的规则条件。 它表示基础条件是否已超过定义的警报规则阈值。

MonitorService

设置规则 (监视) 的监视服务。

Severity

警报的严重性 Sev0 最高,Sev4 为最低。

SignalType

警报所基于的信号类型,可以是指标、日志或活动日志。

actionStatus

操作状态

名称 类型 说明
isSuppressed

boolean

指示是否禁止显示警报的值。

alert

在警报管理服务中创建的警报。

名称 类型 说明
id

string

Azure 资源 ID

name

string

Azure 资源名称

properties

alertProperties

警报属性包

type

string

Azure 资源类型

alertProperties

警报属性包

名称 类型 说明
context

object

特定于监视服务的信息,可提供有关警报的更多上下文详细信息。

egressConfig

object

用于在门户中显示数据的配置。

essentials

essentials

此对象包含跨不同监视服务的一致字段。

AlertState

警报对象状态,可由用户修改。

名称 类型 说明
Acknowledged

string

Closed

string

New

string

errorResponse

来自服务的错误响应。

名称 类型 说明
error

errorResponseBody

错误响应的详细信息。

errorResponseBody

错误响应的详细信息。

名称 类型 说明
code

string

错误代码,旨在以编程方式使用。

details

errorResponseBody[]

有关错误的其他详细信息的列表。

message

string

错误的说明,用于在用户界面中显示。

target

string

特定错误的目标,例如属性的名称。

essentials

此对象包含跨不同监视服务的一致字段。

名称 类型 说明
actionStatus

actionStatus

操作状态

alertRule

string

规则 (监视触发警报实例) 。 根据监视服务,这将是 ARM ID 或规则的名称。

alertState

AlertState

警报对象状态,可由用户修改。

description

string

警报说明。

lastModifiedDateTime

string

上次修改时间 (警报实例的 ISO-8601 格式) 。

lastModifiedUserName

string

上次修改警报的用户(在监视服务更新的情况下)将是“system”,否则为用户的名称。

monitorCondition

MonitorCondition

监视服务中的规则条件。 它表示基础条件是否已超过定义的警报规则阈值。

monitorConditionResolvedDateTime

string

已解决警报实例 (ISO-8601 格式) 的时间。 当监视服务解决警报实例时,将更新此状态,因为不再满足规则条件。

monitorService

MonitorService

设置规则 (监视) 的监视服务。

severity

Severity

警报的严重性 Sev0 最高,Sev4 为最低。

signalType

SignalType

警报所基于的信号类型,可以是指标、日志或活动日志。

smartGroupId

string

智能组的唯一 ID

smartGroupingReason

string

描述将此警报实例添加到智能组的原因的详细原因

sourceCreatedId

string

监视服务为每个警报实例创建的唯一 ID。 这可用于跟踪监视服务中的问题,例如 Nagios、Zabbix、SCOM 等。

startDateTime

string

警报实例的创建时间 (ISO-8601 格式) 。

targetResource

string

创建警报的目标 ARM 资源。

targetResourceGroup

string

创建警报的目标 ARM 资源的资源组。

targetResourceName

string

创建警报的目标 ARM 资源名称的名称。

targetResourceType

string

创建警报的目标 ARM 资源的资源类型。

MonitorCondition

监视服务中的规则条件。 它表示基础条件是否已超过定义的警报规则阈值。

名称 类型 说明
Fired

string

Resolved

string

MonitorService

设置规则 (监视) 的监视服务。

名称 类型 说明
ActivityLog Administrative

string

ActivityLog Autoscale

string

ActivityLog Policy

string

ActivityLog Recommendation

string

ActivityLog Security

string

Application Insights

string

Log Analytics

string

Nagios

string

Platform

string

Resource Health

string

SCOM

string

ServiceHealth

string

SmartDetector

string

VM Insights

string

Zabbix

string

Severity

警报的严重性 Sev0 最高,Sev4 为最低。

名称 类型 说明
Sev0

string

Sev1

string

Sev2

string

Sev3

string

Sev4

string

SignalType

警报所基于的信号类型,可以是指标、日志或活动日志。

名称 类型 说明
Log

string

Metric

string

Unknown

string