获取指定的告警规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| log:GetAlert | get | *全部资源 * |
| 无 |
请求语法
GET /alerts/{alertName} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名称 | ali-test-project |
| alertName | string | 是 | 告警规则 ID | alert-0123456789-123456 |
返回参数
示例
正常返回示例
JSON格式
{
"name": "alert-123456",
"displayName": "alertNameExample",
"description": "Alert Desc",
"configuration": {
"muteUntil": 1698907508,
"version": 2,
"type": "default",
"templateConfiguration": {
"id": "sls.app.ack.ip.not_enough",
"type": "sys",
"version": 1,
"lang": "cn",
"tokens": {
"test": "test",
"test2": 1
},
"aonotations": {
"test": "test",
"test2": 1
}
},
"dashboard": "dasnboardExample",
"threshold": 1,
"noDataFire": false,
"noDataSeverity": 6,
"sendResolved": false,
"queryList": [
{
"chartTitle": "chartExmaple",
"query": "* | select *",
"timeSpanType": "Relative",
"start": "-5m",
"end": "now",
"storeType": "log",
"project": "projectExample",
"store": "store Example",
"region": "cn-hangzhou",
"roleArn": "",
"dashboardId": "dashboardExample",
"powerSqlMode": "auto",
"ui": ""
}
],
"annotations": [
{
"key": "title",
"value": "example value"
}
],
"labels": [
{
"key": "title",
"value": "example value"
}
],
"conditionConfiguration": {
"condition": "cnt > 100",
"countCondition": "__count__ > 5"
},
"severityConfigurations": [
{
"severity": 8,
"evalCondition": {
"condition": "cnt > 100",
"countCondition": "__count__ > 5"
}
}
],
"joinConfigurations": [
{
"type": "left_join",
"condition": "$0.id == $1.id"
}
],
"groupConfiguration": {
"type": "custom",
"fields": [
"id"
]
},
"policyConfiguration": {
"alertPolicyId": "sls.builtin.dynamic",
"actionPolicyId": "example_action_policy",
"repeatInterval": "10m"
},
"autoAnnotation": false,
"sinkEventStore": {
"enabled": true,
"endpoint": "cn-shanghai-intranet.log.aliyuncs.com",
"project": "exampleProject",
"eventStore": "exampleStore",
"roleArn": "acs:ram::123456789:role/aliyunlogetlrole"
},
"sinkCms": {
"enabled": true
},
"sinkAlerthub": {
"enabled": true
},
"tags": [
"host"
]
},
"schedule": {
"type": "Cron",
"cronExpression": "0/5 * * * *",
"runImmediately": false,
"timeZone": "+0800",
"delay": 4,
"interval": "1m"
},
"createTime": 0,
"lastModifiedTime": 0,
"status": "ENABLED/DISABLED"
}错误码
访问错误中心查看更多错误码。
| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
|---|---|---|---|
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息，请参见通用错误码。