SetEventSubscription - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Configura as definições de assinatura de eventos para uma instância de banco de dados.

Descrição da operação

Antes de chamar esta operação, observe os seguintes itens:

Se você usar um SDK da Alibaba Cloud ou um SDK do Database Autonomy Service (DAS) para chamar esta operação, recomendamos que use a versão mais recente do SDK.
Se você usar um SDK para chamar as operações de API do DAS, deve definir o ID da região como cn-shanghai.
Certifique-se de que a instância de banco de dados que você deseja gerenciar esteja conectada ao DAS.

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

hdm:SetEventSubscription

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	rm-2ze8g2am97624****
EventContext	string	Não	Os cenários de eventos suportados. Você pode definir o valor como AllContext, que indica que todos os cenários são suportados.	AllContext
Lang	string	Não	O idioma das notificações de eventos. Você pode definir o valor como zh-CN, que indica que as notificações de eventos são enviadas em chinês.	zh-CN
MinInterval	string	Não	O intervalo mínimo entre notificações de eventos consecutivas. Unidade: segundos.	60
ContactName	string	Não	O nome do contato que recebe notificações de alerta. Separe vários nomes com vírgulas (,).	Default contact
ChannelType	string	Não	O método de notificação. Valores válidos: hdm_alarm_sms: mensagem de texto. dingtalk: chatbot do DingTalk. hdm_alarm_sms_and_email: mensagem de texto e e-mail. hdm_alarm_sms,dingtalk: mensagem de texto e chatbot do DingTalk.	hdm_alarm_sms,dingtalk
ContactGroupName	string	Não	O nome do grupo de contatos que recebe notificações de alerta. Separe vários nomes com vírgulas (,).	Default contact group
Level	string	Não	O nível de risco dos eventos. Valores válidos: Notice: eventos que acionam notificações, incluindo eventos nos níveis Notice, Optimization, Warn e Critical. Optimization: eventos que acionam otimizações, incluindo eventos nos níveis Optimization, Warn e Critical. Warn: eventos que acionam avisos, incluindo eventos nos níveis Warn e Critical. Critical: eventos que acionam avisos críticos. O conteúdo a seguir descreve os eventos em cada nível em detalhes: Notice: eventos relacionados a exceções de banco de dados para os quais nenhuma sugestão é gerada. Optimization: eventos para os quais sugestões de otimização são geradas com base no status do banco de dados. Warn: eventos que podem afetar a execução do banco de dados. Critical: eventos que afetam a execução do banco de dados.	Optimization
Active	string	Não	Especifica se o recurso de assinatura de eventos deve ser ativado. Valores válidos: 0: desativa o recurso de assinatura de eventos. 1: ativa o recurso de assinatura de eventos.	1
Severity	string	Não	A severidade do alerta com base no tipo de evento. Especifique este parâmetro no seguinte formato: `{"Event type 1":"Alert severity", "Event type 2":"Alert severity"}`. Valores válidos de tipos de evento: AutoScale: evento de auto scaling. SQLThrottle: evento de throttling. TimeSeriesAbnormal: evento para detecção de anomalias em séries temporais. SQLOptimize: evento de otimização de SQL. ResourceOptimize: evento de otimização de armazenamento. Valores válidos de severidades de alerta: info noticed warning critical	{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}
DispatchRule	string	Não	As regras de notificação com base no tipo de evento. Se você deixar este parâmetro vazio, os valores de MinInterval e ChannelType prevalecerão. Especifique este parâmetro no seguinte formato: `{"silenced": {"Event type 1":Specifies whether to enable adaptive silence, "Event type 2":Specify whether to enable adaptive silence},"min_interval": {"Event type 1":Minimum interval between event notifications, "Event type 2":Minimum interval between event notifications},"alert_type": {"Event type 1":"Notification method", "Event type 2":"Notification method"}}`. silenced: especifica se o silêncio adaptativo deve ser ativado. Após ativar o silêncio adaptativo, o intervalo entre notificações de alerta consecutivas para um evento é o maior entre o intervalo mínimo especificado por min_interval e um terço da duração do evento. Valores válidos: 1: ativa o silêncio adaptativo. 2: desativa o silêncio adaptativo. min_interval: o intervalo mínimo entre notificações de eventos. Unidade: segundos. alert_type: o método de notificação. Valores válidos: hdm_alarm_sms: mensagem de texto. dingtalk: chatbot do DingTalk. hdm_alarm_sms_and_email: mensagem de texto e e-mail. hdm_alarm_sms,dingtalk: mensagem de texto e chatbot do DingTalk.	{"silenced": {"AutoScale":1, "SQLThrottle":0, "TimeSeriesAbnormal": 1}, "min_interval": {"AutoScale":300, "SQLThrottle":360, "TimeSeriesAbnormal": 120}, "alert_type": {"AutoScale":"hdm_alarm_sms", "SQLThrottle":"hdm_alarm_sms_and_email", "TimeSeriesAbnormal": "hdm_alarm_sms,dingtalk"}}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	097F0C56-B252-515A-B602-FC56EF93EF8A
Message	string	A mensagem retornada. Nota Se a solicitação foi bem-sucedida, Successful é retornado. Se a solicitação falhou, uma mensagem de erro, como um código de erro, é retornada.	Successful
Data	object	As informações detalhadas.
userId	string	O ID do usuário.	1088760496****
instanceId	string	O ID da instância.	rm-2ze8g2am97624****
eventContext	string	Os cenários de eventos suportados. Apenas AllContext é retornado para este parâmetro, o que indica que todos os cenários são suportados.	AllContext
lang	string	O idioma das notificações de eventos. Apenas zh-CN é retornado para este parâmetro, o que indica que as notificações de eventos são enviadas em chinês.	zh_CN
active	integer	Indica se o recurso de assinatura de eventos está ativado. Valores válidos: 0: o recurso de assinatura de eventos está desativado. 1: o recurso de assinatura de eventos está ativado.	1
minInterval	integer	O intervalo mínimo entre notificações de eventos consecutivas. Unidade: segundos.	60
contactName	string	O nome do contato que recebe notificações de alerta. Vários nomes são separados por vírgulas (,).	Default contact
contactGroupName	string	O nome do grupo de contatos que recebe notificações de alerta. Vários nomes são separados por vírgulas (,).	Default contact group
channelType	string	O método de notificação. Valores válidos: hdm_alarm_sms: mensagem de texto. dingtalk: chatbot do DingTalk. hdm_alarm_sms_and_email: mensagem de texto e e-mail. hdm_alarm_sms,dingtalk: mensagem de texto e chatbot do DingTalk.	hdm_alarm_sms,dingtalk
level	string	O nível de risco dos eventos. Valores válidos: Notice Optimization Warn Critical	Optimization
Code	string	O código de status HTTP retornado.	200
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "097F0C56-B252-515A-B602-FC56EF93EF8A",
  "Message": "Successful",
  "Data": {
    "userId": "1088760496****",
    "instanceId": "rm-2ze8g2am97624****",
    "eventContext": "AllContext",
    "lang": "zh_CN",
    "active": 1,
    "minInterval": 60,
    "contactName": "Default contact",
    "contactGroupName": "Default contact group",
    "channelType": "hdm_alarm_sms,dingtalk",
    "level": "Optimization"
  },
  "Code": "200",
  "Success": "true"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.