Consulta de notificaciones para una instancia de ApsaraDB RDS - - Centro de documentación de Alibaba Cloud

Puede llamar a la operación QueryNotify para consultar las notificaciones de una instancia de ApsaraDB RDS.

Las notificaciones se resaltan en la parte superior de la consola de ApsaraDB RDS. Estas incluyen recordatorios de renovación y avisos sobre fallos en la creación de instancias.

Después de llamar a esta operación para consultar las notificaciones, puede invocar la operación ConfirmNotify para marcarlas como confirmadas; esto indica que ha comprendido su contenido.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryNotify	La operación que desea ejecutar. Establezca el valor en QueryNotify.
WithConfirmed	Boolean	Sí	false	Especifica si los resultados de la consulta incluyen notificaciones confirmadas. Valores válidos: true false Nota Una notificación confirmada es aquella que se ha marcado como tal mediante la llamada a la operación ConfirmNotify.
From	String	Sí	2022-05-02T08:38:37Z	Inicio del intervalo de tiempo a consultar. Especifique la hora en formato ISO 8601: yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.
To	String	Sí	2022-05-09T08:38:37Z	Fin del intervalo de tiempo a consultar. La hora de finalización debe ser posterior a la de inicio. Especifique la hora en formato ISO 8601: yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.
PageSize	Integer	No	30	Número de entradas a devolver por página. Valores válidos: 30 50 100 Valor predeterminado: 30.
PageNumber	Integer	No	1	Número de la página a devolver. Valores válidos: cualquier entero positivo distinto de cero. Valor predeterminado: 1.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Data	Object		Detalles de los parámetros devueltos.
NotifyItemList	Array of NotifyItemList		Detalles de la notificación.
Id	Long	103499	ID de la notificación.
GmtCreated	String	2022-04-21T02:04:04Z	Hora de creación de la notificación.
GmtModified	String	2022-04-21T02:10:47Z	Hora de modificación de la notificación.
AliUid	Long	22973492**********	ID de la cuenta de Alibaba Cloud.
IdempotentId	String	ETnLKlblzczshOTUbOCzxxxxxxxxxx	Este parámetro garantiza la idempotencia de la notificación y evita que se envíe repetidamente.
IdempotentCount	String	0	Número de veces que se bloqueó el envío repetido de la notificación.
Type	String	Sell	Tipo de notificación. Valores válidos: Sell: notificación de ventas Operation: notificación de operaciones y mantenimiento Promotion: notificación promocional
Level	String	error	Nivel de la notificación. Valores válidos: help success warning error loading notice
TemplateName	String	InstanceCreateFailed	Plantilla de la notificación. Valores válidos: RenewalRecommend: plantilla utilizada para enviar sugerencias de renovación. InstanceCreateFailed: plantilla utilizada para notificar que una instancia no se pudo crear y fue reembolsada.
NotifyElement	String	{\"orderId\":21466**********}	Elemento dentro de la plantilla de notificación. Este parámetro es una cadena JSON. Los campos de dicha cadena varían según el valor del parámetro TemplateName. Si el parámetro TemplateName es RenewalRecommend, la cadena JSON contiene los siguientes campos: instanceName: ID de la instancia próxima a vencer reservedTime: periodo de validez restante de la instancia, en días Si el parámetro TemplateName es InstanceCreateFailed, la cadena JSON contiene los siguientes campos: orderId: ID del pedido de compra de la instancia reason: causa del fallo en la creación de la instancia
ConfirmFlag	Boolean	true	Indica si la notificación está confirmada. Puede llamar a la operación ConfirmNotify para marcarla como confirmada. Valores válidos: true false
Confirmor	Long	0	UID del contacto que llamó a la operación ConfirmNotify para marcar la notificación como confirmada. El contacto pertenece a la cuenta actual de Alibaba Cloud. El valor 0 indica que el sistema confirmó automáticamente la notificación.
PageSize	Integer	25	Número de entradas devueltas por página.
PageNumber	Integer	1	Número de la página devuelta.
TotalRecordCount	Integer	1	Número total de entradas.
RequestId	String	94CB8D93-017A-5AE7-A118-6E0F89D93C0A	ID de la solicitud.

Ejemplos

Solicitudes de ejemplo

http(s)://rds.aliyuncs.com/?Action=QueryNotify
&WithConfirmed=false
&From=2022-05-02T08:38:37Z
&To=2022-05-09T08:38:37Z
&PageSize=30
&PageNumber=1
&Common request parameters

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryNotifyResponse>
    <Data>
        <NotifyItemList>
            <Id>103499</Id>
            <GmtCreated>2022-04-21T02:04:04Z</GmtCreated>
            <GmtModified>2022-04-21T02:10:47Z</GmtModified>
            <IdempotentId>ETnLKlblzczshOTUbOCzxxxxxxxxxx</IdempotentId>
            <IdempotentCount>0</IdempotentCount>
            <Type>Sell</Type>
            <Level>error</Level>
            <TemplateName>InstanceCreateFailed</TemplateName>
            <NotifyElement>{\"orderId\":21466**********}</NotifyElement>
            <ConfirmFlag>true</ConfirmFlag>
            <Confirmor>0</Confirmor>
        </NotifyItemList>
        <PageSize>25</PageSize>
        <PageNumber>1</PageNumber>
        <TotalRecordCount>1</TotalRecordCount>
    </Data>
    <RequestId>94CB8D93-017A-5AE7-A118-6E0F89D93C0A</RequestId>
</QueryNotifyResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "NotifyItemList" : [ {
      "Id" : 103499,
      "GmtCreated" : "2022-04-21T02:04:04Z",
      "GmtModified" : "2022-04-21T02:10:47Z",
      "IdempotentId" : "ETnLKlblzczshOTUbOCzxxxxxxxxxx",
      "IdempotentCount" : "0",
      "Type" : "Sell",
      "Level" : "error",
      "TemplateName" : "InstanceCreateFailed",
      "NotifyElement" : "{\\\"orderId\\\":21466**********}",
      "ConfirmFlag" : true,
      "Confirmor" : 0
    } ],
    "PageSize" : 25,
    "PageNumber" : 1,
    "TotalRecordCount" : 1
  },
  "RequestId" : "94CB8D93-017A-5AE7-A118-6E0F89D93C0A"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Param.Invalid	Param invalid	Se devuelve este mensaje porque los parámetros de solicitud especificados no son válidos.
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time	Se devuelve este mensaje porque la hora de finalización es anterior a la hora de inicio.

Para obtener una lista de los códigos de error, visite el Centro de errores de API.