全部产品
云市场

查询提货券服务

更新时间:2019-01-02 11:31:53

API Name

QueryRedeem

Overview

查询用户提货券信息.

Request parameters

Name Type Required Description
EffectiveOrNot Boolean No 提货券是否生效: True, False. 为空默认False.
ExpiryTimeStart String No 失效开始时间. 格式: yyyy-MM-dd’T’HH:mm:ss’Z’, 样例: 2018-08-01T00:00:00Z
ExpiryTimeEnd String No T失效结束时间. 格式: yyyy-MM-dd’T’HH:mm:ss’Z’, 样例: 2018-08-01T00:00:00Z
PageNum Integer No The current page number.
PageSize Integer No The number of items that are displayed on each page.

Response parameters

Name Type Required
RedeemId String 提货券ID.
RedeemNo String 提货券Number.
Status String 提货券状态:Generated, CallBack, RefundPending, Canceled, Order_Canceled, ActivePending, ActiveSuccess, ExchangePending, ExchangeSuccess, Expired
GrantedTime String 发行时间.
EffectiveTime String 生效时间.
ExpiryTime String 失效时间.
NominalValue String 面额.
Balance String 余额.
ApplicableProducts String 适用产品.
Specification String 提货券规格.

错误码

错误码 错误信息 HTTP状态码语义
NotApplicable This API is not applicable for caller. 400 该用户没有访问API的权限。
MissingParameter The specified parameter xx is mandatory for this request. 400 指定的参数未设置。
InvalidParameter The specified moduleCode is not valid. 400 指定的参数不合法。
InvalidModuleCode The specified moduleCode is not valid. 400 模块标识不合法。
InvalidConfigCode The specified configCode is not valid. 400 模块属性标识不合法。
InvalidOwner The specified owner doesn’t belong to caller. 400 指定的拥有者从属关系不属于调用者。
InvalidCaller The specified caller doesn’t exists. 400 调用者不合法。
InternalError The request processing has failed due to some unknown error, exception or failure. 400 内部未知错误。

请求样例

  1. https://business.aliyuncs.com/?Action=QueryRedeem
  2. &ExpiryTimeStart=
  3. &ExpiryTimeEnd=
  4. &EffectiveOrNot=
  5. &PageNum=
  6. &PageSize=

返回样例

  1. "Data": {
  2. "Redeem": {
  3. "Redeem": [
  4. {
  5. "Status": "expired",
  6. "ApplicableProducts": "云服务器(包年包月国际站1)",
  7. "NominalValue": "0",
  8. "Specification": "",
  9. "Balance": "0",
  10. "RedeemId": "15",
  11. "ExpiryTime": "2018-06-13 20:25:00",
  12. "EffectiveTime": "2018-05-14 20:25:00",
  13. "RedeemNo": "4889*****1610",
  14. "GrantedTime": "2018-05-14 20:25:00"
  15. }
  16. ]
  17. },
  18. "TotalCount": 1,
  19. "PageSize": 20,
  20. "PageNum": 1
  21. },
  22. "Message": "Successful!",
  23. "RequestId": "555C62F8-88C5-4FC5-A929-B8C544FC6AEC",
  24. "Success": true,
  25. "Code": "Success"