GetAlert - Simple Log Service: Central de Documentação do Alibaba Cloud

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

log:GetAlert

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /alerts/{alertName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
alertName	string	Sim	O ID da regra de alerta.	alert-0123456789-123456

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
project	string	Sim	O nome do projeto.	ali-test-project

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	Alert	As configurações da regra de alerta.

Exemplos

Resposta de sucesso

JSON formato

{
  "name": "alert-123456",
  "displayName": "alertNameExample",
  "description": "Alert Desc",
  "configuration": {
    "muteUntil": 1698907508,
    "version": "2.0",
    "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": "FixedRate",
    "cronExpression": "0/5 * * * *",
    "runImmediately": false,
    "timeZone": "+0800",
    "delay": 4,
    "interval": "60s"
  },
  "createTime": 1695090077,
  "lastModifiedTime": 1714274900,
  "status": "ENABLED/DISABLED"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.