ListAlertRules - DataWorks: Central de Documentação do Alibaba Cloud

Consulta uma lista de regras de alerta de monitoramento personalizadas.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Owner	string	Não	O ID da conta Alibaba Cloud usada pelo proprietário da regra.	1933790683****
TaskIds	array	Não	Os IDs das tarefas de agendamento.
	integer	Não	O ID da tarefa de agendamento.	1234
Types	array	Não	A lista de tipos de alerta.
	string	Não	O tipo de alerta. Valores válidos: Finished: Uma instância termina a execução. UnFinished: Uma instância não termina a execução antes de um ponto no tempo especificado. Error: Ocorre um erro em uma instância. CycleUnfinished: Uma instância não termina a execução conforme o esperado dentro de um ciclo específico. Timeout: Uma instância atinge o tempo limite. InstanceTransferComplete: Uma instância é gerada pelo nó acionado automaticamente. InstanceTransferFluctuate: O número de instâncias geradas flutua. ExhaustedError: Um erro persiste após uma instância ser reexecutada automaticamente. InstanceKeyword: Uma instância com erros contém palavras-chave especificadas. InstanceErrorCount: O número de instâncias nas quais ocorre um erro atinge um limite especificado. InstanceErrorPercentage: A proporção de instâncias nas quais ocorre um erro no workspace em relação ao número total de instâncias atinge um limite especificado. ResourceGroupPercentage: A taxa de uso do grupo de recursos atinge um limite especificado. ResourceGroupWaitCount: O número de instâncias que estão aguardando recursos no grupo de recursos atinge um limite especificado.	Error
Receiver	string	Não	O ID da conta Alibaba Cloud usada pelo destinatário do alerta.	1933790683****
Name	string	Não	O nome da regra.	error_rule
PageNumber	integer	Sim	O número da página. As páginas começam na página 1.	1
PageSize	integer	Sim	O número de entradas por página. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	A6C6B486-E3A2-5D52-9E76-D9380485D946
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem às condições.	5
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
AlertRules	array<object>	As regras.
	array<object>
Id	integer	O ID da regra.	22125
Name	string	O nome da regra.	error_test
Owner	string	O ID da conta Alibaba Cloud usada pelo proprietário da regra.	1933790683****
Enabled	boolean	Indica se a regra está ativada.	true
TriggerCondition	object	A condição de acionamento do alerta.
Type	string	O tipo de alerta. Valores válidos: Finished: Uma instância termina a execução. UnFinished: Uma instância não termina a execução antes de um ponto no tempo especificado. Error: Ocorre um erro em uma instância. CycleUnfinished: Uma instância não termina a execução conforme o esperado dentro de um ciclo específico. Timeout: Uma instância atinge o tempo limite. InstanceTransferComplete: Uma instância é gerada pelo nó acionado automaticamente. InstanceTransferFluctuate: O número de instâncias geradas flutua. ExhaustedError: Um erro persiste após uma instância ser reexecutada automaticamente. InstanceKeyword: Uma instância com erros contém palavras-chave especificadas. InstanceErrorCount: O número de instâncias nas quais ocorre um erro atinge um limite especificado. InstanceErrorPercentage: A proporção de instâncias nas quais ocorre um erro no workspace em relação ao número total de instâncias atinge um limite especificado. ResourceGroupPercentage: A taxa de uso do grupo de recursos atinge um limite especificado. ResourceGroupWaitCount: O número de instâncias que estão aguardando recursos no grupo de recursos atinge um limite especificado.	Error
Extension	object	As informações estendidas sobre a regra. Este parâmetro é obrigatório para tipos específicos de alertas.
Error	object	A configuração para um alerta do tipo Error.
StreamTaskIds	array	Os IDs das tarefas de computação em tempo real. Este parâmetro é obrigatório quando você monitora tarefas de computação em tempo real.
	integer	O ID da tarefa de computação em tempo real.	123
AutoRerunAlertEnabled	boolean	Indica se um alerta é acionado caso uma tarefa em lote seja reexecutada automaticamente após uma falha.	false
Timeout	object	A configuração para um alerta do tipo Timeout.
TimeoutInMinutes	integer	O período de tempo limite. Unidade: minutos.	10
UnFinished	object	A configuração para um alerta do tipo UnFinished.
UnFinishedTime	string	O horário mais recente de conclusão da instância. O período está no formato hh:mm. Valores válidos de hh: [0,47]. Valores válidos de mm: [0,59].	12:00
CycleUnfinished	object	A configuração para um alerta do tipo CycleUnfinished.
CycleAndTime	array<object>	As configurações do ciclo de agendamento e do período de tempo limite da instância.
	object
CycleId	integer	O ID do ciclo de agendamento da instância. Valores válidos: [1,288].	1
Time	string	O horário mais recente de conclusão da instância dentro do ciclo de agendamento. O horário está no formato hh:mm. Valores válidos de hh: [0,47]. Valores válidos de mm: [0,59].	01:00
InstanceErrorCount	object	A configuração para um alerta do tipo InstanceErrorCount.
Count	integer	O número máximo de instâncias nas quais ocorre um erro. Valores válidos: [1,10000].	10
InstanceErrorPercentage	object	A configuração para um alerta do tipo InstanceErrorPercentage.
Percentage	integer	A porcentagem máxima de instâncias nas quais ocorre um erro no workspace em relação ao número total de instâncias. Valores válidos: [1-100].	10
InstanceTransferFluctuate	object	A configuração para um alerta do tipo InstanceTransferFluctuate.
Trend	string	A maneira como o número de instâncias de nós acionados automaticamente geradas no seu workspace flutua. Valores válidos: abs: o valor absoluto. O número de instâncias aumenta ou diminui. increase: O número de instâncias aumenta. decrease: O número de instâncias diminui.	abs
Percentage	integer	A porcentagem máxima de flutuação no número de instâncias de nós acionados automaticamente geradas no seu workspace. Valores válidos: [1-100].	10
Target	object	Os objetos monitorados.
Type	string	O tipo dos objetos monitorados. Valores válidos: Task: nó Baseline: linha de base Project: workspace BizProcess: fluxo de trabalho	Task
Ids	array	Os IDs dos objetos monitorados.
	integer	O ID do objeto monitorado.	32567
AllowTasks	array	Os nós que não devem ser monitorados.
	integer	O ID do nó que não deve ser monitorado.	123123

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D938048****",
  "PagingInfo": {
    "TotalCount": 5,
    "PageNumber": 1,
    "PageSize": 10,
    "AlertRules": [
      {
        "Id": 22125,
        "Name": "error_test",
        "Owner": "1933790683****",
        "Enabled": true,
        "TriggerCondition": {
          "Type": "Error",
          "Extension": {
            "Error": {
              "StreamTaskIds": [
                123
              ],
              "AutoRerunAlertEnabled": false
            },
            "Timeout": {
              "TimeoutInMinutes": 10
            },
            "UnFinished": {
              "UnFinishedTime": "12:00"
            },
            "CycleUnfinished": {
              "CycleAndTime": [
                {
                  "CycleId": 1,
                  "Time": "01:00"
                }
              ]
            },
            "InstanceErrorCount": {
              "Count": 10
            },
            "InstanceErrorPercentage": {
              "Percentage": 10
            },
            "InstanceTransferFluctuate": {
              "Trend": "abs",
              "Percentage": 10
            }
          },
          "Target": {
            "Type": "Task",
            "Ids": [
              32567
            ],
            "AllowTasks": [
              123123
            ]
          }
        }
      }
    ]
  }
}

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.