GetEventSubscription - Database Autonomy Service - Centro de documentación de Alibaba Cloud

Consulta la configuración de suscripción a eventos de una instancia de base de datos.

Descripción de la operación

Antes de llamar a esta operación, tenga en cuenta los siguientes puntos:

Si utiliza un SDK de Alibaba Cloud o un SDK de Database Autonomy Service (DAS) para llamar a esta operación, se recomienda que utilice la versión más reciente del SDK.
Si utiliza un SDK para llamar a operaciones de DAS, debe establecer el ID de región en cn-shanghai.
La instancia de base de datos que desea gestionar está conectada a DAS.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

hdm:GetEventSubscription

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia.	rm-2ze8g2am97624****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Message	string	El mensaje devuelto. Nota Si la solicitud fue exitosa, se devuelve Successful. Si la solicitud falló, se devuelve un mensaje de error, como un código de error.	Successful
Data	object	Los datos devueltos.
userId	string	El ID de usuario.	1088760496****
instanceId	string	El ID de la instancia.	rm-2ze8g2am97624****
eventContext	string	Los escenarios de eventos admitidos. Solo se puede devolver AllContext, lo que indica que todos los escenarios son compatibles.	AllContext
lang	string	El idioma de las notificaciones de eventos. Solo se puede devolver zh-CN, lo que indica que las notificaciones de eventos se envían en chino.	zh_CN
active	integer	Indica si la función de suscripción a eventos está habilitada. Valores válidos: 0: La función de suscripción a eventos está deshabilitada. 1: La función de suscripción a eventos está habilitada.	1
minInterval	string	El intervalo mínimo entre notificaciones de eventos. Unidad: segundos.	60
contactName	string	El nombre del suscriptor que recibe las notificaciones de alerta. Varios nombres se separan con comas (,).	默认联系人
contactGroupName	string	El nombre del grupo de contactos que recibe las notificaciones de alerta. Varios nombres se separan con comas (,).	默认联系组
channelType	string	El método de notificación. Valores válidos: hdm_alarm_sms: mensaje de texto. dingtalk: chatbot de DingTalk. hdm_alarm_sms_and_email: mensaje de texto y correo electrónico. hdm_alarm_sms,dingtalk: mensaje de texto y chatbot de DingTalk.	hdm_alarm_sms,dingtalk
level	string	El nivel de riesgo de los eventos que activan las notificaciones. Valores válidos: Notice Optimization Warn Critical	Optimization
contacts	array<object>	El ID de usuario.
	object
name	string	El nombre del contacto de alerta.	张先生
phone	string	El número de celular del contacto de alerta.	1390000****
email	string	La dirección de correo electrónico del contacto de alerta.	a***@example.net
dingtalkHook	string	La URL del webhook del chatbot de DingTalk.	https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****
groups	array	Los grupos de contactos a los que pertenece el contacto de alerta.	Mr. Zhang
	string	El nombre del contacto de alerta.	张先生
isCmsReduplicated	boolean	Indica si el nombre del contacto de alerta es igual al nombre del contacto en CloudMonitor. true false	true
userId	string	El ID de usuario.	1088760496****
contactGroups	array<object>	Los grupos de contactos de alerta.
	object
name	string	El nombre del grupo de contactos de alerta.	张先生
description	string	La descripción del grupo de contactos de alerta.	默认联系人
contacts	string	Los miembros del grupo de contactos de alerta.	"[\"张先生\",\"王女士\",\"李先生\"]"
userId	string	El ID de usuario.	1088760496****
eventSendGroup	array	Los escenarios de eventos admitidos en los que se puede enviar la suscripción a eventos.
	string	El escenario de evento admitido en el que se pueden enviar notificaciones de eventos. Solo se puede devolver AllContext, lo que indica que todos los escenarios son compatibles.	AllContext
id	integer	El ID de clave principal de la base de datos.	1
gmtCreate	integer	La hora en que se habilitó la suscripción a eventos. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1633071840000
gmtModified	integer	La hora en que se modificó por última vez la configuración de suscripción a eventos. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.	1633071850000
Code	string	El código de estado HTTP devuelto.	200
Success	string	Indica si la solicitud fue exitosa. Valores válidos: true false	true

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.