查询代金券信息
最近更新时间: 2026-04-10 00:05:52
1. 接口描述
接口请求域名: bill.api3.fincloud.tencent.cn。
查询代金券信息
默认接口请求频率限制:20次/秒。
接口更新时间:2020-12-25 18:21:49。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CouponInfo |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-10-25 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| MidasAppId | 是 | 否 | String | 米大师appid 示例值: 1341057229 |
| SpStatus | 否 | 否 | String | 指定查询状态,1: 待使用,2: 冻结, 3: 已作废, 9: 已使用, 15: 已过期, 16: 未到有效期起始时间 示例值: 1 |
| ProductCode | 否 | 否 | String | 指定产品 示例值: p_cvm |
| SpId | 否 | 否 | String | 指定代金券编号 示例值: 1341057229_202411010011000000010909452710bat672366379274a_001 |
| SortField | 否 | 否 | String | SortField 示例值: EndTime |
| SortOrder | 否 | 否 | String | 指定升序降序:desc、asc 示例值: desc |
| Limit | 是 | 否 | Int64 | 指定查询的每页最大记录数,默认10个 示例值: 20 |
| Offset | 是 | 否 | Int64 | 指定当前查询第几页,默认第1页 示例值: 0 |
| EndTime | 否 | 否 | String | 券到期时间 示例值: 2018-10-24 10:00:00 |
| LargestEndTime | 否 | 否 | String | 最大过期时间 示例值: 2018-10-25 00:00:00 |
| ProductInfo | 否 | 否 | String | 产品定义 示例值: [{"name": "\u89c4\u683c\u7c7b\u578b", "value": "\u6807\u51c6\u7248"}, {"name": "\u4ea7\u54c1\u578b\u53f7", "value": "\u5165\u95e8\u578b"}, {"name": "\u5cf0\u503c\u5e26\u5bbd", "value": "1MB/s"}, {"name": "\u78c1\u76d8\u5bb9\u91cf", "value": "10GB"}, {"name": "\u7f51\u7edc", "value": "vpc-ofn1s40f"}, {"name": "\u5b50\u7f51", "value": "subnet-cgh97d9w"}, {"name": "\u96c6\u7fa4", "value": "yf1 cluster"}, {"name": "\u5b9e\u4f8b\u540d", "value": "drms-4df61cdc"}, {"name": "\u6d88\u606f\u4fdd\u7559\u65f6\u957f", "value": "1440\u5206"}] |
| MemberUin | 否 | 否 | String | 成员账号uin 示例值: 1000102441223 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CouponsList | Array of CouponInfo | 代金券信息 示例值:查看 |
| TotalNum | Int64 | 记录总数 示例值: 10000 |
| TotalBalance | Int64 | 记录总数 示例值: 10000 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误 |
| InvalidParameterValue | 参数取值错误 |
| FailedOperation | 操作失败 |