有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: billing.tencentcloudapi.com 。

获取按产品汇总消耗详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCostSummaryByProduct。
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需要,默认不需要
示例值:1

3. 输出参数

参数名称 类型 描述
Ready Integer 数据是否准备好,0未准备好,1准备好
示例值:1
Total ConsumptionSummaryTotal 消耗详情
Data Array of ConsumptionBusinessSummaryDataItem 消耗按产品汇总详情
注意:此字段可能返回 null,表示取不到有效值。
RecordNum Integer 记录数量,NeedRecordNum为0是返回null
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取按产品汇总消耗详情

获取按产品汇总消耗详情

输入示例

POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCostSummaryByProduct
<公共请求参数>

{
    "NeedRecordNum": "1",
    "EndTime": "2018-11",
    "Limit": "1",
    "BeginTime": "2018-11",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Ready": 1,
        "RecordNum": 2,
        "Total": {
            "RealTotalCost": "220.67"
        },
        "Data": [
            {
                "BusinessCode": "p_cvm",
                "BusinessCodeName": "云服务器",
                "RealTotalCost": "220.67",
                "Trend": {
                    "Type": "postPay",
                    "Value": "test"
                }
            }
        ],
        "RequestId": "59a408bc-5d95-4d40-bf21-58e5e8d48dd0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.GatewayError 网关错误。