首页 云数据库 RDS API参考 API目录 通知 QueryNotify - 查询通知

QueryNotify - 查询通知

该接口用于查询RDS的通知。

接口说明

RDS通知会以高亮的形式展示于RDS控制台顶部，包含续费提醒、实例创建失败提醒等。

通过本接口查询了通知以后，您可以调用ConfirmNotify将该通知标记为已确认，代表您已知晓该通知的内容。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
WithConfirmedboolean是

查询结果中是否包含已确认的通知。取值：

  • true：包含
  • false：不包含
说明已确认的通知即已通过ConfirmNotify接口标记为已确认的通知。
false
Fromstring是

查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2022-05-02T08:38:37Z
Tostring是

查询结束时间，需要晚于开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

2022-05-09T08:38:37Z
PageSizeinteger否

每页记录数，取值：

  • 30
  • 50
  • 100

默认值：30。

30
PageNumberinteger否

页码，取值：大于0且不超过Integer的最大值。

默认值：1。

1

返回参数

名称类型描述示例值
object

PlainResponse

Dataobject

返回字段列表。

NotifyItemListobject []

通知列表。

Idlong

通知ID。

103499
GmtCreatedstring

通知创建时间。

2022-04-21T02:04:04Z
GmtModifiedstring

通知修改时间。

2022-04-21T02:10:47Z
AliUidlong

当前阿里云主账号的ID。

22973492**********
IdempotentIdstring

用于保证通知的幂等性，防止重复发送通知。

ETnLKlblzczshOTUbOCzxxxxxxxxxx
IdempotentCountstring

重复发送的通知被拦截的次数。

0
Typestring

通知类型。返回值：

  • Sell：售卖通知
  • Operation：运维通知
  • Promotion：促销通知
Sell
Levelstring

通知的等级。返回值：

  • help：帮助级别
  • success：执行成功级别
  • warning：警告级别
  • error：执行失败级别
  • loading：任务进行中
  • notice：普通级别
error
TemplateNamestring

通知模版。返回值：

  • RenewalRecommend：续费建议
  • InstanceCreateFailed：实例创建失败且退款
InstanceCreateFailed
NotifyElementstring

通知模板中的元素，由JSON字符串组成。TemplateName不同，JSON中包含的参数不同。

  • TemplateName为RenewalRecommend：
    • instanceName：即将过期实例的ID。
    • reservedTime：剩余天数。
  • TemplateName为InstanceCreateFailed：
    • orderId：购买实例的订单号。
    • reason：实例创建失败的原因。
{\"orderId\":21466**********}
ConfirmFlagboolean

通知是否已被接收，即是否已调用ConfirmNotify接口将通知标记为已确认。返回值：

  • true：是
  • false：否
true
Confirmorlong

当前阿里云账号下通知接收人的UID，该UID调用了ConfirmNotify接口将通知标记为已确认。

返回0代表该通知被系统自动接收。

0
PageSizeinteger

每页记录数。

25
PageNumberinteger

页码。

1
TotalRecordCountinteger

总记录数。

1
RequestIdstring

请求ID。

94CB8D93-017A-5AE7-A118-6E0F89D93C0A

示例

正常返回示例

JSON格式

{
  "Data": {
    "NotifyItemList": [
      {
        "Id": 103499,
        "GmtCreated": "2022-04-21T02:04:04Z",
        "GmtModified": "2022-04-21T02:10:47Z",
        "AliUid": 0,
        "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"
}

错误码

HTTP status code错误码错误信息描述
400Param.InvalidParam invalid请求参数错误
400Param.Invalid.TimeEndBeforeStartParam invalid. End time before start time参数错误，结束时间早于开始时间

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 关系型数据库 相关技术圈