文档

QueryNotify - 查询通知

更新时间:

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

功能说明

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

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

ETnLKlblzczshOTUbOCz****
IdempotentCountstring

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

0
Typestring

通知类型。返回值:

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

通知的等级。返回值:

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

通知模版。返回值:

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

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

  • TemplateNameRenewalRecommend
    • instanceName:即将过期实例的 ID。
    • reservedTime:剩余天数。
  • TemplateNameInstanceCreateFailed
    • 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": "ETnLKlblzczshOTUbOCz****",
        "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参数错误,结束时间早于开始时间
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)