1. 接口描述
接口请求域名： billing.tencentcloudapi.com 。
获取按计费模式汇总费用分布
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBillSummaryByPayMode。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-09。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| BeginTime | 是 | String | 目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。 示例值：2018-11 |
| EndTime | 是 | String | 目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。 示例值：2018-11 |
| PayerUin | 否 | String | 查询账单数据的用户UIN 示例值：xxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Ready | Integer | 数据是否准备好，0准备中，1已就绪。（Ready=0，为当前UIN首次进行初始化出账，预计需要5~10分钟出账，请于10分钟后重试即可） 示例值：1 |
| SummaryOverview | Array of PayModeSummaryOverviewItem | 各付费模式花费分布详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取按付费模式汇总费用分布
获取按付费模式汇总费用分布
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummaryByPayMode
<公共请求参数>
{
"EndTime": "2018-11",
"BeginTime": "2018-11"
}输出示例
{
"Response": {
"Ready": 1,
"SummaryOverview": [
{
"PayMode": "prePay",
"PayModeName": "包年包月",
"RealTotalCost": "3228.80000000",
"TotalCost": "5064.00000000",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "3228.80000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "99.49",
"Detail": [
{
"ActionType": "prepay_renew",
"ActionTypeName": "包年包月续费",
"RealTotalCost": "3228.80000000",
"TotalCost": "5064.00000000",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "3228.80000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "100.00",
"BillMonth": "2021-12"
}
]
},
{
"PayMode": "postPay",
"PayModeName": "按量计费",
"RealTotalCost": "16.44000000",
"TotalCost": "27.64446128",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "16.44000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "0.51",
"Detail": [
{
"ActionType": "postpay_deduct_h",
"ActionTypeName": "按量计费小时结",
"RealTotalCost": "19.32711686",
"TotalCost": "29.73402790",
"CashPayAmount": "3.83470332",
"IncentivePayAmount": "15.49241354",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "96.00",
"BillMonth": "2021-12"
},
{
"ActionType": "postpay_deduct_d",
"ActionTypeName": "按量计费日结",
"RealTotalCost": "0.80604458",
"TotalCost": "1.24113445",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.80604458",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "4.00",
"BillMonth": "2021-12"
},
{
"ActionType": "postpay_deduct_m",
"ActionTypeName": "按量计费月结",
"RealTotalCost": "0.00000000",
"TotalCost": "0.36246037",
"CashPayAmount": "0.00000000",
"IncentivePayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "0.00",
"BillMonth": "2021-12"
},
{
"ActionType": "billVirtualId",
"ActionTypeName": "月度计费精度差异",
"RealTotalCost": "-3.69316144",
"TotalCost": "-3.69316144",
"CashPayAmount": "-3.83470332",
"IncentivePayAmount": "0.14154188",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000",
"RealTotalCostRatio": "0.00",
"BillMonth": "2021-12"
}
]
}
],
"RequestId": "5d83209a-3223-497f-a36b-32330d88e454"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.GatewayError | 网关错误。 |
| InternalError.UnknownError | 未定义异常。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
