1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
成员账号获取管理账号代付账单(按资源汇总)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBillResourceSummaryForOrganization。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Offset | 是 | Integer | 分页偏移量,Offset=0表示第一页,如果Limit=100,则Offset=100表示第二页,Offset=200表示第三页,依次类推 示例值:0 |
Limit | 是 | Integer | 数量,最大值为1000 示例值:1 |
Month | 是 | String | 月份,格式为yyyy-mm。不能早于开通账单2.0的月份 示例值:2018-08 |
NeedRecordNum | 否 | Integer | 是否需要访问列表的总记录数,用于前端分页 1-表示需要, 0-表示不需要 |
ActionType | 否 | String | 查询交易类型(请使用交易类型名称入参),入参示例枚举如下: 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月迁出资源 预付费用 小时费用 预留实例退款 按量计费冲正 包年包月转按量 保底扣款 节省计划小时费用 示例值:按量计费扣费 |
ResourceId | 否 | String | 查询指定资源信息 示例值:ins-1op7g2iz |
PayMode | 否 | String | 付费模式 prePay/postPay 示例值:prePay |
BusinessCode | 否 | String | 产品名称代码 备注:如需获取当月使用过的BusinessCode,请调用API:获取产品汇总费用分布 示例值:p_cvm |
TagKey | 否 | String | 分账标签键,用户自定义(支持2021-01以后账单查询) 示例值:province |
TagValue | 否 | String | 分账标签值,该参数为空表示该标签键下未设置标签值的记录 (支持2021-01以后账单查询) 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResourceSummarySet | Array of BillDistributionResourceSummary | 资源汇总列表 |
Total | Integer | 资源汇总列表总数,入参NeedRecordNum为0时不返回 注意:此字段可能返回 null,表示取不到有效值。 示例值:103 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取账单资源汇总
获取账单资源汇总
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationBillResourceSummary
<公共请求参数>
{
"Offset": 0,
"Limit": 1,
"Month": "2023-08",
"NeedRecordNum": 1,
"ResourceId": "cdb-0a90mrac"
}
输出示例
{
"Response": {
"RequestId": "0a27bddd-8683-4187-b9c0-7d407a2c818f",
"ResourceSummarySet": [
{
"ActionTypeName": "包年包月续费",
"BusinessCode": "p_cdb",
"BusinessCodeName": "云数据库MySQL",
"CashPayAmount": "11.56675785",
"ConfigDesc": "云数据库MySQL-CPU: 1 核",
"Discount": "0.325825",
"ExtendField1": "vpc: vpc-l0u15j26,Default-VPC",
"ExtendField2": "vip: 172.27.0.8",
"ExtendField3": "-",
"ExtendField4": "-",
"ExtendField5": "-",
"FeeBeginTime": "2023-08-07 10:58:41",
"FeeEndTime": "2023-09-07 10:58:41",
"IncentivePayAmount": "0.00000000",
"InstanceType": "-",
"OperateUin": "700000686592",
"OrderId": "20230807867037044170861",
"OriginalCostWithRI": "0.00000000",
"OriginalCostWithSP": "0.00000000",
"OwnerUin": "700000686592",
"PayModeName": "包年包月",
"PayTime": "2023-08-07 03:42:18",
"ProductCode": "sp_cdb_master",
"ProductCodeName": "云数据库MySQL-高可用版-通用型",
"ProjectName": "默认项目",
"RealTotalCost": "11.56675785",
"ReduceType": "折扣",
"RegionId": 16,
"RegionName": "西南地区(成都)",
"ResourceId": "cdb-0a90mrac",
"ResourceName": "云数据库mysql-test7",
"SPDeduction": "0.00000000",
"Tags": [],
"TotalCost": "35.5",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"ZoneName": "成都一区"
}
],
"Total": 3
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.SummaryDataNotReady | 汇总数据正在构建中,请稍后再试。 |
InternalError.GatewayError | 网关错误。 |
InternalError.UnknownError | 未定义异常。 |