Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to query vouchers.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeVoucherInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Limit | Yes | Integer | How many data entries per page, 20 is selected by default, maximum not exceeding 1000 |
| Offset | Yes | Integer | Page number, starts from 1 by default |
| Status | No | String | Voucher status: pending use: unUsed, Used: used, delivered: delivered, discarded: cancel, expired: overdue |
| VoucherId | No | String | Voucher id |
| CodeId | No | String | Voucher order id |
| ProductCode | No | String | product code |
| ActivityId | No | String | Activity id |
| VoucherName | No | String | Voucher name |
| TimeFrom | No | String | Start time of delivery. Example: 2021-01-01 |
| TimeTo | No | String | Delivery end time. Example: 2021-01-01 |
| SortField | No | String | Specified sorting field: BeginTime start time, EndTime expiry time, CreateTime creation time |
| SortOrder | No | String | Specify ascending/descending order: desc, asc |
| PayMode | No | String | Payment mode, postPay (postpaid)/prePay (prepaid)/riPay (reserved instance)/"" or "*" means all modes. If payMode is "" or "*", productCode and subProductCode must be empty. |
| PayScene | No | String | Payment scenario PayMode=postPay: spotpay - spot instance, "settle account" - standard post-paid. PayMode=prePay: purchase - monthly subscription new purchase, renew - annual and monthly renewal (auto renewal), modify - monthly subscription configuration change. PayMode=riPay: oneOffFee - prepayment of reserved instance, hourlyFee - hourly charge for reserved instance, * - support all payment scenarios. |
| Operator | No | String | Operator is used by default as user uin |
| VoucherMainType | No | String | The primary types of vouchers are has_price and no_price, which represent the cash voucher with a price and the cash voucher without a price respectively. |
| VoucherSubType | No | String | Voucher subtype: Discount is a discount voucher, and deduct is a deduction voucher. |
| StartTimeFrom | No | String | Voucher validity start time |
| StartTimeTo | No | String | Voucher validity time end time |
| EndTimeFrom | No | String | Voucher expiration time start time |
| EndTimeTo | No | String | Voucher expiration time end time |
| CreateTimeFrom | No | String | Voucher issuance start time |
| CreateTimeTo | No | String | Voucher issuance time end time |
| Lang | No | String | Language parameter Default value: zh Expect the product name to return in Chinese or other languages. Currently only support Chinese and English. Return in Chinese when "zh" is entered or left blank; return in English in other cases. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total count |
| TotalBalance | Integer | Total balance (differential) |
| VoucherInfos | Array of VoucherInfos | Voucher information related to |
| Unit | String | Unit of the amount field in the API response Default value: micro Currency unit: micro (microcent) |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVoucherInfo
<Common request parameters>
{
"Limit": 1,
"Offset": 1
}
{
"Response": {
"TotalBalance": 265645002000000,
"TotalCount": 1828,
"RequestId": "47f4df05-5c77-467b-8c83-6b9304e20321",
"VoucherInfos": [
{
"Status": "",
"PolicyRemark": "",
"EndTime": "0002-11-30",
"NominalValue": 1200000000,
"CreateTime": "2016-03-12 14:51:52",
"BeginTime": "0002-11-30",
"PayMode": "prePay",
"PayScene": "purchase,renew",
"VoucherId": "PPVIA653S3T7L07A4P",
"ExcludedProducts": [
{
"PayMode": "*",
"GoodsName": "Tencent Cloud Lighthouse"
},
{
"PayMode": "*",
"GoodsName": "Tencent QiDian Customer Service"
},
{
"PayMode": "*",
"GoodsName": "Tencent QiDian Marketing Cloud"
}
],
"OwnerUin": "909619400",
"Balance": 1200000000,
"ApplicableProducts": {
"PayMode": "prePay",
"GoodsName": "Cloud Virtual Machine CVM"
}
}
],
"Unit": "micro"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidAppId | Invalid App ID. |
| InternalError | Internal error. |
| InternalError.GatewayError | Gateway error. |
| InvalidParameter | Invalid parameter. |
| UnauthorizedOperation.CamNoAuth | The account does not have CAM permission. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários