文档

QueryRedeem - 查询提货券服务

更新时间:
一键部署

查询用户提货券信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:QueryRedeemRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ExpiryTimeStartstring

失效开始时间。格式:yyyy-MM-ddTHH:mm:ssZ。

2018-08-01T00:00:00Z
ExpiryTimeEndstring

失效结束时间。格式:yyyy-MM-ddTHH:mm:ssZ。

2018-08-01T00:00:00Z
EffectiveOrNotboolean

提货券是否生效:

  • true。
  • false。

默认 false。

true
PageNuminteger

页码。

1
PageSizeinteger

每页显示条数。

10

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful
RequestIdstring

请求 ID。

E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B
Successboolean

是否成功。

true
Dataobject

返回数据。

PageNumlong

页码。

1
PageSizelong

每页显示条数。

10
TotalCountlong

总记录数。

1
Redeemobject []

提货券详情。

ExpiryTimestring

提货券失效时间。

2018-06-13 20:25:00
GrantedTimestring

提货券发行时间。

2018-05-14 20:25:00
Statusstring

提货券状态,取值:

  • Generated:已生成。
  • CallBack:已回调。
  • RefundPending:提货券退款中。
  • Canceled:提货券已作废。
  • Order_Canceled:提货券已作废。
  • ActivePending:激活中,请稍后。
  • ActiveSuccess:激活成功。
  • ExchangePending:兑换中。
  • ExchangeSuccess:兑换成功。
  • Expired:已过期。
  • Invalid:已作废。
Generated
Specificationstring

提货券规格。

NominalValuestring

面额。

0
EffectiveTimestring

提货券生效时间。

2018-05-14 20:25:00
RedeemIdstring

提货券 ID。

1342
RedeemNostring

提货券 Number。

4889*****1610
ApplicableProductsstring

适用产品。

云服务器
Balancestring

余额。

0

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Redeem": {
      "Redeem": [
        {
          "ExpiryTime": "2018-06-13 20:25:00",
          "GrantedTime": "2018-05-14 20:25:00",
          "Status": "Generated",
          "Specification": "无",
          "NominalValue": "0",
          "EffectiveTime": "2018-05-14 20:25:00",
          "RedeemId": "1342",
          "RedeemNo": "4889*****1610",
          "ApplicableProducts": "云服务器",
          "Balance": "0"
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息
400NotAuthorizedThis API is not authorized for caller.
400NotApplicableThis API is not applicable for caller.
400InvalidOwnerThe specified owner doesn't belong to caller.
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2023-08-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
  • 本页导读 (0)
文档反馈