调用QueryCashCoupons查询用户代金券信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryCashCoupons

系统规定参数。取值：QueryCashCoupons。
ExpiryTimeEnd String 否 2018-08-01T00:00:00Z

失效时间起，格式：yyyy-MM-ddTHH:mm:ssZ，样例：2018-08-01T00:00:00Z。
ExpiryTimeStart String 否 2018-08-01T00:00:00Z

失效时间起，格式：yyyy-MM-ddTHH:mm:ssZ，样例：2018-08-01T00:00:00Z。
EffectiveOrNot Boolean 否 true

代金券是否生效。取值范围：

  • true。
  • false。

返回数据

名称 类型 示例值 描述
Code String Success

状态码。
Data Array

返回信息。
CashCoupon
ApplicableProducts String 通用

适用产品。
ApplicableScenarios String 阿里云按量付费账单,阿里云新购

适用场景。
Balance String 100.00

剩余金额。
CashCouponId Long 34534253254325

代金券ID。
CashCouponNo String Q-b1485def8f04a

代金券编码。
EffectiveTime String 2018-08-02T15:15:50Z

生效时间。
ExpiryTime String 2019-01-29T15:15:50Z

失效时间。
GrantedTime String 2018-08-02T15:15:50Z

发放时间。
NominalValue String 100.00

面额。
Status String Available

取值：

  • Available：有效。
  • Expired：过期。
  • Cancelled：作废。
Message String Successful

错误信息。
RequestId String 147B566E-DB4C-4E43-BDBB-5DB1D9D268DB

请求ID。
Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryCashCoupons
&<公共请求参数>

正常返回示例

XML 格式 

<QueryCashCouponsResponse>
      <Message>Successful!</Message>
      <RequestId>147B566E-DB4C-4E43-BDBB-5DB1D9D268DB</RequestId>
      <Data>
            <CashCoupon></CashCoupon>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</QueryCashCouponsResponse>

JSON 格式 

{
	"Message": "Successful!",
	"RequestId": "147B566E-DB4C-4E43-BDBB-5DB1D9D268DB",
	"Data": {
		"CashCoupon": []
	},
	"Code": "Success",
	"Success": true
}

错误码

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