文档中心 计费相关 API 文档 账单管理相关接口 获取按标签汇总费用分布

获取按标签汇总费用分布

最近更新时间:2019-09-26 20:19:48

1. 接口描述

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

获取按标签汇总费用分布

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillSummaryByTag
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
PayerUin String 查询账单数据的用户UIN
BeginTime String 目前只支持传当月开始,且必须和EndTime为相同月份,例 2018-09-01 00:00:00
EndTime String 目前只支持传当月结束,且必须和BeginTime为相同月份,例 2018-09-30 23:59:59
TagKey String 分账标签键

3. 输出参数

参数名称 类型 描述
Ready Integer 数据是否准备好,0未准备好,1准备好
SummaryOverview TagSummaryOverviewItem 各标签值花费分布详情
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取按标签汇总费用分布

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeBillSummaryByTag
&PayerUin=100000007615
&BeginTime=2019-09-01 00:00:00
&EndTime=2019-09-30 23:59:59
&TagKey=province
&<公共请求参数>

输出示例

{
  "Response": {
    "Ready": 1,
    "SummaryOverview": [
      {
        "TagValue": "",
        "RealTotalCost": "0.30",
        "RealTotalCostRatio": "17.08"
      },
      {
        "TagValue": "shanghai",
        "RealTotalCost": "0.26",
        "RealTotalCostRatio": "15.21"
      },
      {
        "TagValue": "beijing",
        "RealTotalCost": "0.26",
        "RealTotalCostRatio": "15.21"
      },
      {
        "TagValue": "guangdong",
        "RealTotalCost": "0.26",
        "RealTotalCostRatio": "15.21"
      },
      {
        "TagValue": "xiamen",
        "RealTotalCost": "0.22",
        "RealTotalCostRatio": "12.43"
      },
      {
        "TagValue": "tianjin",
        "RealTotalCost": "0.22",
        "RealTotalCostRatio": "12.43"
      },
      {
        "TagValue": "sichuan",
        "RealTotalCost": "0.22",
        "RealTotalCostRatio": "12.43"
      }
    ],
    "SummaryTotal": {
      "RealTotalCost": "1.74"
    },
    "RequestId": "b7649c63-59e5-49d3-bbde-64292cc4174d"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TagKeyNotExist 不存在该分账标签键