1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
成员账号获取管理账号代付账单(费用明细)。
注意事项:在请求接口时,由于网络不稳定或其它异常,可能会导致请求失败。如果您遇到这种情况,我们建议您在接口请求失败时,手动发起重试操作,这样可以更好地确保您的接口请求能够成功执行。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBillDetailForOrganization。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Offset | 是 | Integer | 分页偏移量,Offset=0表示第一页,如果Limit=100,则Offset=100表示第二页,Offset=200表示第三页,依次类推 示例值:1 |
Limit | 是 | Integer | 数量,最大值为100 示例值:1 |
Month | 否 | String | 月份,格式为yyyy-mm,Month和BeginTime&EndTime必传一个,如果有传BeginTime&EndTime则Month字段无效。最多可拉取近18个月内的数据。 示例值:2018-07 |
BeginTime | 否 | String | 周期开始时间,格式为yyyy-mm-dd hh:ii:ss,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传,且为相同月份,不支持跨月查询,查询结果是整月数据。最多可拉取18个月内的数据。 示例值:2018-11-01 00:00:00 |
EndTime | 否 | String | 周期结束时间,格式为yyyy-mm-dd hh:ii:ss,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传,且为相同月份,不支持跨月查询,查询结果是整月数据。最多可拉取近18个月内的数据。 示例值:2018-11-01 23:59:59 |
NeedRecordNum | 否 | Integer | 是否需要访问列表的总记录数,用于前端分页 1-表示需要, 0-表示不需要 示例值:1 |
PayMode | 否 | String | 付费模式 prePay(表示包年包月)/postPay(表示按时按量) 示例值:prePay |
ResourceId | 否 | String | 查询指定资源信息 示例值:ins-49zhx6z1 |
ActionType | 否 | String | 查询交易类型(请使用交易类型名称入参),入参示例枚举如下: 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月迁出资源 预付费用 小时费用 预留实例退款 按量计费冲正 包年包月转按量 保底扣款 节省计划小时费用 示例值:按量计费日结 |
ProjectId | 否 | Integer | 项目ID:资源所属项目ID 示例值:0 |
BusinessCode | 否 | String | 产品名称代码 备注:如需获取当月使用过的BusinessCode,请调用API:获取产品汇总费用分布 示例值:p_cvm |
Context | 否 | String | 上一次请求返回的上下文信息,翻页查询Month>=2023-05的月份的数据可加快查询速度,数据量10万级别以上的用户建议使用,查询速度可提升2~10倍 示例值:UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DetailSet | Array of DistributionBillDetail | 详情列表 |
Total | Integer | 总记录数,24小时缓存一次,可能比实际总记录数少 注意:此字段可能返回 null,表示取不到有效值。 示例值:11841 |
Context | String | 本次请求的上下文信息,可用于下一次请求的请求参数中,加快查询速度 注意:此字段可能返回 null,表示取不到有效值。 示例值:UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取账单明细
获取账单明细
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationBillDetail
<公共请求参数>
{
"Offset": 0,
"Limit": 1,
"Month": "2023-08",
"NeedRecordNum": 1,
"ResourceId": "nat-ftuh6xel"
}
输出示例
{
"Response": {
"Context": "TQpr+vp4d9EeM04pEI6ryHAVS3ZI84mbSVbUzlTD1F8EzZ6vYfNp+wKVhGw0dGkA2iAr5lSGYE4O+bTWApdUY6ZcLDZGpQVYCVApRrjx0IUf6NJGoV8FXlYLQxABqcSt",
"DetailSet": [
{
"ActionType": "postpay_deduct_h",
"ActionTypeName": "按量计费小时结",
"AssociatedOrder": null,
"BillId": "20230816400705427744482",
"BusinessCode": "p_nat",
"BusinessCodeName": "NAT网关",
"ComponentSet": [
{
"BlendedDiscount": "0.68040500",
"CashPayAmount": "0.34020250",
"ComponentCode": "v_nat_hour_instance",
"ComponentCodeName": "实例",
"ComponentConfig": [],
"ContractPrice": "0.34020250",
"Cost": "0.50000000",
"DeductedMeasure": "-",
"Discount": "0.680405",
"IncentivePayAmount": "0",
"InstanceType": "",
"ItemCode": "sv_nat_hour_instance_small",
"ItemCodeName": "NAT网关-小型实例",
"OriginalCostWithRI": "0.00000000",
"OriginalCostWithSP": "0.00000000",
"PriceUnit": "元/100个/小时",
"RealCost": "0.34020250",
"RealTotalMeasure": "-",
"ReduceType": "折扣",
"RiTimeSpan": "0.00000000",
"SPDeduction": "0.00000000",
"SPDeductionRate": "0.00000000",
"SinglePrice": "0.50000000",
"SpecifiedPrice": "0.50000000",
"TimeSpan": "1",
"TimeUnitName": "小时",
"TransferPayAmount": "0",
"UsedAmount": "100",
"UsedAmountUnit": "个",
"VoucherPayAmount": "0"
}
],
"FeeBeginTime": "2023-08-16 20:00:00",
"FeeEndTime": "2023-08-16 20:59:59",
"Formula": "-",
"FormulaUrl": "https://buy.cloud.tencent.com/price/nat",
"OperateUin": "700000686592",
"OrderId": "20230816867705427744432",
"OwnerUin": "700000686592",
"PayModeName": "按量计费",
"PayTime": "2023-08-16 21:15:38",
"PriceInfo": [],
"ProductCode": "sp_nat",
"ProductCodeName": "NAT网关",
"ProjectId": 0,
"ProjectName": "默认项目",
"RegionId": "4",
"RegionName": "华东地区(上海)",
"ResourceId": "nat-ftuh6xel",
"ResourceName": "migration-nat-test3",
"Tags": [],
"ZoneName": "其他"
}
],
"RequestId": "48f32947-8ef2-40b3-94ef-b8c08fc030da",
"Total": 544
}
}
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.QueryCountFailed | 获取数据条数失败。 |
InternalError | 内部错误。 |
InternalError.GatewayError | 网关错误。 |
InternalError.UnknownError | 未定义异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
UnsupportedOperation | 操作不支持。 |