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

Consulta as configurações de assinatura de eventos de 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 do 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 operações do DAS, deverá definir o ID da região como cn-shanghai.
A instância de banco de dados que você deseja gerenciar está 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:GetEventSubscription

get

*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****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro, como um código de erro, será retornada.	Successful
Data	object	Os dados retornados.
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 pode ser retornado, o que indica que todos os cenários são suportados.	AllContext
lang	string	O idioma das notificações de eventos. Apenas zh-CN pode ser retornado, 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	string	O intervalo mínimo entre as notificações de eventos. Unidade: segundos.	60
contactName	string	O nome do assinante 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 que acionam notificações. Valores válidos: Notice Optimization Warn Critical	Optimization
contacts	array<object>	O ID do usuário.
	object
name	string	The name of the alert contact.	Mr. Zhang
phone	string	The mobile number of the alert contact.	1390000****
email	string	The email address of the alert contact.	a***@example.net
dingtalkHook	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groups	array	The contact groups to which the alert contact belongs.	Mr. Zhang
	string	The name of the alert contact.	张先生
isCmsReduplicated	boolean	Indicates whether the alert contact name is the same as the contact name on CloudMonitor. true false	true
userId	string	The user ID.	1088760496****
contactGroups	array<object>	Os grupos de contatos de alerta.
	object
name	string	The name of the alert contact group.	张先生
description	string	The description of the alert contact group.	Default contact
contacts	string	The members of the alert contact group.	"[\"Mr. Zhang\",\"Mr. Wang\",\"Mr. Li\"]"
userId	string	The user ID.	1088760496****
eventSendGroup	array	Os cenários de eventos suportados nos quais a assinatura de eventos pode ser enviada.
	string	O cenário de eventos suportado no qual as notificações de eventos podem ser enviadas. Apenas AllContext pode ser retornado, o que indica que todos os cenários são suportados.	AllContext
id	integer	O ID da chave primária do banco de dados.	1
gmtCreate	integer	A hora em que a assinatura de eventos foi ativada. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.	1633071840000
gmtModified	integer	A hora em que as configurações de assinatura de eventos foram modificadas mais recentemente. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.	1633071850000
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": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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",
    "contacts": [
      {
        "name": "Mr. Zhang",
        "phone": "1390000****",
        "email": "a***@example.net",
        "dingtalkHook": "https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****",
        "groups": [
          "张先生"
        ],
        "isCmsReduplicated": true,
        "userId": "1088760496****"
      }
    ],
    "contactGroups": [
      {
        "name": "张先生",
        "description": "Default contact",
        "contacts": "\"[\\\"Mr. Zhang\\\",\\\"Mr. Wang\\\",\\\"Mr. Li\\\"]\"",
        "userId": "1088760496****"
      }
    ],
    "eventSendGroup": [
      "AllContext"
    ],
    "id": 1,
    "gmtCreate": 1633071840000,
    "gmtModified": 1633071850000
  },
  "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.