1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
查看成本分析明细
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCostExplorerSummary。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
BeginTime | 是 | String | 周期开始时间,格式为yyyy-mm-dd hh:ii:ss 示例值:2023-01-01 00:00:00 |
EndTime | 是 | String | 周期结束时间,格式为yyyy-mm-dd hh:ii:ss 示例值:2024-01-01 23:59:59 |
BillType | 是 | String | 账单类型:1-费用账单、2-消耗账单 示例值:1 |
PeriodType | 是 | String | 统计周期:日-day,月-month; 示例值:day |
Dimensions | 是 | String | 分类维度(数据汇总维度),查询分类维度(请使用分类维度code入参)入参枚举值: default=仅总计 feeType=费用类型 billType=账单类型 business=产品 product=子产品 region=地域 zone=可用区 actionType=交易类型 payMode =计费模式 tags=标签 project =项目 payerUin=支付者账号 ownerUin=使用者账号 示例值:business |
FeeType | 是 | String | 费用类型:cost-总费用,totalCost-原价费用 示例值:cost |
PageSize | 是 | Integer | 数量,每页最大值为100 示例值:100 |
PageNo | 是 | Integer | 起始页,当PageNo=1表示第一页, PageNo=2表示第二页,依次类推。 示例值:1 |
TagKeyStr | 否 | String | 分账标签值 示例值:test |
NeedConditionValue | 否 | String | 是否需要筛选框, 1-表示需要, 0-表示不需要,若不传默认不需要。 示例值:0 |
Conditions | 否 | AnalyseConditions | 筛选参数 示例值:{} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 数据条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
Header | AnalyseHeaderDetail | 表头信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "name":"产品", "total":"总计", "headDetail":[ { "name":"2023-12-01 00:00:00" }, { "name":"2024-01-01 00:00:00" } ] } |
Detail | Array of AnalyseDetail | 数据明细 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "name":"云服务器CVM", "total":11.63454774, "timeDetail":[ { "time":"2023-12-01 00:00:00", "money":"2.92527168" }, { "time":"2024-01-01 00:00:00", "money":"8.70927606" } ] } |
TotalDetail | AnalyseDetail | 数据总计 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "name":"总计", "total":7662.59744864, "timeDetail":[ { "name":"2023-12-01 00:00:00", "money":"7313.09744864" }, { "name":"2024-01-01 00:00:00", "money":"349.50000000" } ] } |
ConditionValue | AnalyseConditionDetail | 筛选框 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按月查询成本分析接口
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCostExplorerSummary
<公共请求参数>
{
"Dimensions": "business",
"PeriodType": "month",
"FeeType": "cost",
"BillType": "1",
"BeginTime": "2023-12-31 00:00:00",
"EndTime": "2024-01-07 23:00:00",
"PageSize": 100,
"PageNo": 1
}
输出示例
{
"Response": {
"Total": 21,
"Header": {
"Name": "产品",
"Total": "总计",
"HeadDetail": [
{
"Name": "2023-12-01 00:00:00"
},
{
"Name": "2023-12-02 00:00:00"
}
]
},
"ConditionValue": {},
"Detail": [
{
"Name": "云服务器CVM",
"Total": "211.52000096",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "211.52000048"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "0.00000048"
}
]
},
{
"Name": "弹性MapReduce",
"Total": "169.55291616",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "84.77645808"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "84.77645808"
}
]
},
{
"Name": "T-Sec-主机安全(CWP)",
"Total": "104.40081600",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "52.20040800"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "52.20040800"
}
]
},
{
"Name": "计费测试商品",
"Total": "100.00000000",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "100.00000000"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "0"
}
]
},
{
"Name": "云数据库MySQL",
"Total": "38.77000000",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "0.00000000"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "38.77000000"
}
]
},
{
"Name": "人脸识别",
"Total": "36.00000000",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "0"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "36.00000000"
}
]
},
{
"Name": "容器服务 TKE",
"Total": "19.00184160",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "9.50092080"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "9.50092080"
}
]
},
{
"Name": "NAT网关",
"Total": "16.28275200",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "8.14137600"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "8.14137600"
}
]
},
{
"Name": "黑石弹性公网IP",
"Total": "9.60076800",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "4.80038400"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "4.80038400"
}
]
},
{
"Name": "节省计划",
"Total": "7.20000000",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "3.60000000"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "3.60000000"
}
]
}
],
"TotalDetail": {
"Name": "总计",
"Total": "724.5825514",
"TimeDetail": [
{
"Time": "2023-12-01 00:00:00",
"Money": "480.64255140"
},
{
"Time": "2023-12-02 00:00:00",
"Money": "243.94000000"
}
]
},
"RequestId": "18619d53-8b77-45f2-a685-ac4490e74c06"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。