调用QueryPrepaidCards账户卡包查询_阿里云交易和账单管理API(BOA)-阿里云帮助中心

查询用户卡包信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ExpiryTimeEnd	string	否	卡包过期结束时间止，格式：yyyy-mm-ddhh:mm:ss。	2018-08-01 00:00:00
ExpiryTimeStart	string	否	卡包过期时间起，格式：yyyy-mm-dd。	2018-08-01 00:00:00
EffectiveOrNot	boolean	否	卡包是否生效。取值范围：-true。-false。	true

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。	Success
Message	string	错误信息。	Successful!
RequestId	string	请求 id。	7EA6C02D-06D0-4213-9C3B-E67910F7D1EB
Success	boolean	是否成功。	true
Data	array<object>	返回数据。
	object
Status	string	取值： Available：有效 Expired：过期 Cancelled：作废	Available
ExpiryTime	string	卡包失效时间。	2019-08-04 01:39:11
GrantedTime	string	卡包发放时间。	2019-08-04 01:39:11
NominalValue	string	面额。	100.00
EffectiveTime	string	卡包生效时间。	2019-08-04 01:39:11
PrepaidCardNo	string	卡包编码。	Q-7edaab979fc9
ApplicableScenarios	string	适用场景描述。	阿里云按量付费账单,阿里云新购
PrepaidCardId	long	卡包 id。	213432432
ApplicableProducts	string	适用产品描述。	通用
Balance	string	剩余金额。	100.00

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "7EA6C02D-06D0-4213-9C3B-E67910F7D1EB",
  "Success": true,
  "Data": {
    "PrepaidCard": [
      {
        "Status": "Available",
        "ExpiryTime": "2019-08-04 01:39:11",
        "GrantedTime": "2019-08-04 01:39:11",
        "NominalValue": "100.00",
        "EffectiveTime": "2019-08-04 01:39:11",
        "PrepaidCardNo": "Q-7edaab979fc9",
        "ApplicableScenarios": "阿里云按量付费账单,阿里云新购",
        "PrepaidCardId": 213432432,
        "ApplicableProducts": "通用",
        "Balance": "100.00"
      }
    ]
  }
}

错误码

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 parameters are 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.

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史