Consultar notificações de uma instância ApsaraDB RDS - : Central de Documentação do Alibaba Cloud

As notificações são exibidas em destaque no topo do console do ApsaraDB RDS. Entre elas estão lembretes de renovação e avisos de falhas na criação de instâncias.

Após chamar esta operação para consultar notificações, chame a operação ConfirmNotify para marcá-las como confirmadas, indicando que você tomou ciência do conteúdo das notificações.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para facilitar o uso, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de requisição

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryNotify	A operação a ser executada. Defina o valor como QueryNotify.
WithConfirmed	Boolean	Yes	false	Indica se os resultados da consulta incluem notificações já confirmadas. Valores válidos: true false Nota Uma notificação confirmada é aquela marcada como confirmada por meio da operação ConfirmNotify.
From	String	Yes	2022-05-02T08:38:37Z	O início do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601, no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.
To	String	Yes	2022-05-09T08:38:37Z	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. Especifique o horário no padrão ISO 8601, no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.
PageSize	Integer	No	30	O número de entradas a serem retornadas por página. Valores válidos: 30 50 100 Valor padrão: 30.
PageNumber	Integer	No	1	O número da página a ser retornada. Valores válidos: qualquer inteiro positivo diferente de zero. Valor padrão: 1.

Parâmetros de resposta

Parameter	Type	Example	Description
Data	Object		Os detalhes dos parâmetros retornados.
NotifyItemList	Array of NotifyItemList		Os detalhes da notificação.
Id	Long	103499	O ID da notificação.
GmtCreated	String	2022-04-21T02:04:04Z	O horário de criação da notificação.
GmtModified	String	2022-04-21T02:10:47Z	O horário da última modificação da notificação.
AliUid	Long	22973492**********	O ID da conta Alibaba Cloud.
IdempotentId	String	ETnLKlblzczshOTUbOCzxxxxxxxxxx	Este parâmetro garante a idempotência da notificação e impede que ela seja enviada repetidamente.
IdempotentCount	String	0	O número de vezes que notificações enviadas repetidamente foram bloqueadas.
Type	String	Sell	O tipo da notificação. Valores válidos: Sell: notificação de vendas Operation: notificação de O&M Promotion: notificação de promoção
Level	String	error	O nível da notificação. Valores válidos: help success warning error loading notice
TemplateName	String	InstanceCreateFailed	O modelo da notificação. Valores válidos: RenewalRecommend: modelo usado para notificar sugestões de renovação. InstanceCreateFailed: modelo usado para notificar que uma instância falhou ao ser criada e foi reembolsada.
NotifyElement	String	{\"orderId\":21466**********}	O elemento do modelo de notificação. Este parâmetro é uma string JSON. Os campos da string JSON variam conforme o valor do parâmetro TemplateName. Se o parâmetro TemplateName for RenewalRecommend, a string JSON contém os seguintes campos: instanceName: o ID da instância prestes a expirar reservedTime: o período de validade restante da instância, em dias Se o parâmetro TemplateName for InstanceCreateFailed, a string JSON contém os seguintes campos: orderId: o ID do pedido de compra da instância reason: a causa da falha na criação da instância
ConfirmFlag	Boolean	true	Indica se a notificação foi confirmada. Chame a operação ConfirmNotify para marcar a notificação como confirmada. Valores válidos: true false
Confirmor	Long	0	O UID do contato que chamou a operação ConfirmNotify para marcar a notificação como confirmada. O contato pertence à conta Alibaba Cloud atual. O valor 0 indica que a notificação foi confirmada automaticamente pelo sistema.
PageSize	Integer	25	O número de entradas retornadas por página.
PageNumber	Integer	1	O número da página retornada.
TotalRecordCount	Integer	1	O número total de entradas.
RequestId	String	94CB8D93-017A-5AE7-A118-6E0F89D93C0A	O ID da requisição.

Exemplos

Exemplos de requisição

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

Exemplos de resposta bem-sucedida

XML format

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>

JSON format

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 erro

HTTP status code	Error code	Error message	Description
400	Param.Invalid	Param invalid	O erro retornado indica que os parâmetros de requisição especificados são inválidos.
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time	O erro retornado indica que o horário de término é anterior ao horário de início.

Para obter a lista de códigos de erro, acesse o API Error Center.