Interroger les notifications d'une instance ApsaraDB RDS - - Centre de documentation Alibaba Cloud

Appelez l'opération QueryNotify pour interroger les notifications associées à une instance ApsaraDB RDS.

Les notifications s'affichent en évidence en haut de la console ApsaraDB RDS. Elles incluent des rappels de renouvellement et des alertes en cas d'échec de création d'instance.

Après avoir interrogé les notifications via cette opération, appelez l'opération ConfirmNotify pour les marquer comme confirmées, ce qui signifie que vous avez pris connaissance de leur contenu.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryNotify	Opération à effectuer. Définissez la valeur sur QueryNotify.
WithConfirmed	Boolean	Yes	false	Indique si les résultats de la requête doivent inclure les notifications confirmées. Valeurs possibles : true false Remarque Une notification confirmée est une notification marquée comme telle via l'appel de l'opération ConfirmNotify.
From	String	Yes	2022-05-02T08:38:37Z	Début de la plage horaire à interroger. Spécifiez l'heure au format ISO 8601 yyyy-MM-ddTHH:mm:ssZ, en temps universel coordonné (UTC).
To	String	Yes	2022-05-09T08:38:37Z	Fin de la plage horaire à interroger. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format ISO 8601 yyyy-MM-ddTHH:mm:ssZ, en temps universel coordonné (UTC).
PageSize	Integer	No	30	Nombre d'entrées à renvoyer par page. Valeurs possibles : 30 50 100 Valeur par défaut : 30.
PageNumber	Integer	No	1	Numéro de la page à renvoyer. Valeurs possibles : tout entier positif non nul. Valeur par défaut : 1.

Paramètres de réponse

Parameter	Type	Example	Description
Data	Object		Détails des paramètres renvoyés.
NotifyItemList	Array of NotifyItemList		Détails de la notification.
Id	Long	103499	ID de la notification.
GmtCreated	String	2022-04-21T02:04:04Z	Heure de création de la notification.
GmtModified	String	2022-04-21T02:10:47Z	Heure de modification de la notification.
AliUid	Long	22973492**********	ID du compte Alibaba Cloud.
IdempotentId	String	ETnLKlblzczshOTUbOCzxxxxxxxxxx	Ce paramètre garantit l'idempotence de la notification et empêche son envoi répété.
IdempotentCount	String	0	Nombre de fois où les notifications envoyées de manière répétée ont été bloquées.
Type	String	Sell	Type de notification. Valeurs possibles : Sell : notification commerciale Operation : notification d'exploitation et de maintenance (O&M) Promotion : notification promotionnelle
Level	String	error	Niveau de la notification. Valeurs possibles : help success warning error loading notice
TemplateName	String	InstanceCreateFailed	Modèle de notification. Valeurs possibles : RenewalRecommend : modèle utilisé pour notifier les suggestions de renouvellement. InstanceCreateFailed : modèle utilisé pour notifier l'échec de création d'une instance et le remboursement associé.
NotifyElement	String	{\"orderId\":21466**********}	Élément présent dans le modèle de notification. Ce paramètre est une chaîne JSON. Les champs de cette chaîne varient selon la valeur du paramètre TemplateName. Si le paramètre TemplateName est défini sur RenewalRecommend, la chaîne JSON contient les champs suivants : instanceName : ID de l'instance sur le point d'expirer reservedTime : durée de validité restante de l'instance, exprimée en jours Si le paramètre TemplateName est défini sur InstanceCreateFailed, la chaîne JSON contient les champs suivants : orderId : ID de la commande d'achat de l'instance reason : cause de l'échec de création de l'instance
ConfirmFlag	Boolean	true	Indique si la notification a été confirmée. Appelez l'opération ConfirmNotify pour marquer la notification comme confirmée. Valeurs possibles : true false
Confirmor	Long	0	UID du contact ayant appelé l'opération ConfirmNotify pour confirmer la notification. Le contact appartient au compte Alibaba Cloud actuel. La valeur 0 indique que la notification a été confirmée automatiquement par le système.
PageSize	Integer	25	Nombre d'entrées renvoyées par page.
PageNumber	Integer	1	Numéro de la page renvoyée.
TotalRecordCount	Integer	1	Nombre total d'entrées.
RequestId	String	94CB8D93-017A-5AE7-A118-6E0F89D93C0A	ID de la requête.

Exemples

Exemple de requête

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

Exemple de réponse réussie

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

Format 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"
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	Param.Invalid	Param invalid	Le message d'erreur indique que les paramètres de requête spécifiés ne sont pas valides.
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time	Le message d'erreur indique que l'heure de fin est antérieure à l'heure de début.

Pour consulter la liste des codes d'erreur, rendez-vous sur le Centre d'erreurs de l'API.