调用QueryCashCoupons查询用户代金券信息_阿里云交易和账单管理API(BOA)-阿里云帮助中心

查询用户代金券信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ExpiryTimeEnd	string	否	代金券终止过期时间，格式：yyyy-MM-ddTHH:mm:ssZ	2018-08-01T00:00:00Z
ExpiryTimeStart	string	否	代金券起始过期时间，格式：yyyy-MM-ddTHH:mm:ssZ	2018-09-01T00:00:00Z
EffectiveOrNot	boolean	否	代金券是否生效。取值范围： true false	true

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码	Success
Message	string	执行结果说明	Successful！
RequestId	string	请求 ID	147B566E-DB4C-4E43-BDBB-5DB1D9D268DB
Success	boolean	是否调用成功。true：调用成功，false：调用失败	true
Data	array<object>	返回数据
	object
Status	string	取值： Available：有效 Expired：过期 Cancelled：作废	Available
ExpiryTime	string	代金券过期时间	2018-08-10T00:00:00Z
GrantedTime	string	代金券发放时间	2018-08-02T15:15:50Z
NominalValue	string	面额	100.00
EffectiveTime	string	代金券生效时间	2018-08-02T15:15:50Z
ApplicableScenarios	string	适用场景描述	阿里云按量付费账单,阿里云新购
CashCouponId	long	代金券 ID	34534253254325
ApplicableProducts	string	适用产品描述	通用
CashCouponNo	string	代金券编码	Q-b1485def8f04a
Balance	string	余额	100.00
Description	string	备注	该代金券用于产品功能验证的测试

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful！",
  "RequestId": "147B566E-DB4C-4E43-BDBB-5DB1D9D268DB",
  "Success": true,
  "Data": {
    "CashCoupon": [
      {
        "Status": "Available",
        "ExpiryTime": "2018-08-10T00:00:00Z",
        "GrantedTime": "2018-08-02T15:15:50Z",
        "NominalValue": "100.00",
        "EffectiveTime": "2018-08-02T15:15:50Z",
        "ApplicableScenarios": "阿里云按量付费账单,阿里云新购",
        "CashCouponId": 34534253254325,
        "ApplicableProducts": "通用",
        "CashCouponNo": "Q-b1485def8f04a",
        "Balance": "100.00",
        "Description": "该代金券用于产品功能验证的测试"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	NotApplicable	This API is not applicable for caller.
400	NotAuthorized	This API is not authorized for caller.
400	MissingParameter	Some parameters arte mandatoryfor this request.
400	InvalidParameter	Some parameter sare not valid.
400	InvalidOwner	The specifiedowner doesn’t belong to caller
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
500	UndefinedError	The request processing has failed due to some unknown error.

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

变更历史

变更时间	变更内容概要	操作
2023-07-19	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情