有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

获取按地域汇总费用分布

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillSummaryByRegion。
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 RegionSummaryOverviewItem 各地域花费分布详情
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取按地域汇总费用分布

获取按地域汇总费用分布

输入示例

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

{
    "EndTime": "2018-11",
    "BeginTime": "2018-11"
}

输出示例

{
    "Response": {
        "Ready": 1,
        "SummaryOverview": [
            {
                "RegionId": "1",
                "RealTotalCost": "100631.85486247",
                "TotalCost": "101708.25486247",
                "CashPayAmount": "2922.91140386",
                "IncentivePayAmount": "97708.94345861",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "55.61",
                "BillMonth": "2021-11",
                "RegionName": "华南地区(广州)"
            },
            {
                "RegionId": "8",
                "RealTotalCost": "52596.91309090",
                "TotalCost": "52596.91309090",
                "CashPayAmount": "64.99381195",
                "IncentivePayAmount": "52531.91927895",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "29.07",
                "BillMonth": "2021-11",
                "RegionName": "华北地区(北京)"
            },
            {
                "RegionId": "4",
                "RealTotalCost": "27731.41174702",
                "TotalCost": "27731.41174702",
                "CashPayAmount": "71.09880801",
                "IncentivePayAmount": "27660.31293901",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "15.32",
                "BillMonth": "2021-11",
                "RegionName": "华东地区(上海)"
            },
            {
                "RegionId": "0",
                "RealTotalCost": "-5.24970039",
                "TotalCost": "-5.24970039",
                "CashPayAmount": "-3059.00402382",
                "IncentivePayAmount": "3053.75432343",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2021-11",
                "RegionName": "其他"
            }
        ],
        "RequestId": "0053df4c-c08d-4f43-bcaf-e181fc501167"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.GatewayError 网关错误。
InternalError.UnknownError 未定义异常。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。