1. 接口描述
接口请求域名： billing.tencentcloudapi.com 。
获取按资源汇总消耗详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCostSummaryByResource。 |
| 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 |
| Limit | 是 | Integer | 每次获取数据量，最大值为100 示例值：1 |
| Offset | 是 | Integer | 偏移量,默认从0开始 示例值：0 |
| PayerUin | 否 | String | 查询账单数据的用户UIN |
| NeedRecordNum | 否 | Integer | 是否需要返回记录数量，0不需要，1需要，默认不需要 |
| NeedConditionValue | 否 | Integer | 是否需要返回过滤条件，0不需要，1需要，默认不需要 |
| Conditions | 否 | Conditions | 过滤条件，只支持ResourceKeyword(资源关键字，支持资源id及资源名称模糊查询)，ProjectIds（项目id），RegionIds(地域id)，PayModes(付费模式，可选prePay和postPay)，HideFreeCost（是否隐藏0元流水，可选0和1），OrderByCost（按费用排序规则，可选desc和asc） |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Ready | Integer | 数据是否准备好，0未准备好，1准备好 示例值：1 |
| Total | ConsumptionSummaryTotal | 消耗详情 注意：此字段可能返回 null，表示取不到有效值。 |
| ConditionValue | ConsumptionResourceSummaryConditionValue | 过滤条件 注意：此字段可能返回 null，表示取不到有效值。 |
| RecordNum | Integer | 记录数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：29 |
| Data | Array of ConsumptionResourceSummaryDataItem | 资源消耗详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取按资源汇总消耗详情
获取按资源汇总消耗详情
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCostSummaryByResource
<公共请求参数>
{
"EndTime": "2018-11",
"Limit": "1",
"BeginTime": "2018-11",
"Offset": "0"
}输出示例
{
"Response": {
"Ready": 1,
"Total": {
"RealTotalCost": "abc"
},
"ConditionValue": {
"Business": [
{
"BusinessCode": "abc",
"BusinessCodeName": "abc"
}
],
"Project": [
{
"ProjectId": "abc",
"ProjectName": "abc"
}
],
"Region": [
{
"RegionId": "abc",
"RegionName": "abc"
}
],
"PayMode": [
{
"PayMode": "abc",
"PayModeName": "abc"
}
]
},
"RecordNum": 1,
"Data": [
{
"ResourceId": "abc",
"ResourceName": "abc",
"RealTotalCost": "abc",
"CashPayAmount": "abc",
"ProjectId": "abc",
"ProjectName": "abc",
"RegionId": "abc",
"RegionName": "abc",
"PayMode": "abc",
"PayModeName": "abc",
"BusinessCode": "abc",
"BusinessCodeName": "abc",
"ConsumptionTypeName": "abc",
"RealCost": "abc",
"FeeBeginTime": "abc",
"FeeEndTime": "abc",
"DayDiff": "abc",
"DailyTotalCost": "abc",
"OrderId": "abc",
"VoucherPayAmount": "abc",
"IncentivePayAmount": "abc",
"TransferPayAmount": "abc",
"PayerUin": "abc",
"OwnerUin": "abc",
"OperateUin": "abc",
"ProductCode": "abc",
"ProductCodeName": "abc",
"RegionType": "abc",
"RegionTypeName": "abc",
"Extend1": "abc",
"Extend2": "abc",
"Extend3": "abc",
"Extend4": "abc",
"Extend5": "abc",
"InstanceType": "abc",
"InstanceTypeName": "abc",
"PayTime": "abc",
"ZoneName": "abc",
"ComponentConfig": "abc"
}
],
"RequestId": "abc"
}
}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.GatewayError | 网关错误。 |
