查询分账账单资源归集汇总

最近更新时间：2024-03-29 01:08:52

我的收藏

1. 接口描述

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

查询分账账单资源归集汇总

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeGatherResource。
Version	是	String	公共参数，本接口取值：2018-07-09。
Region	否	String	公共参数，此参数为可选参数。
Limit	是	Integer	数量，最大值为1000 示例值：10
Offset	是	Integer	分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推示例值：0
Month	否	String	账单月份，格式为2024-02，不传默认当前月示例值：2024-02
TreeNodeUniqKey	否	String	分账单元唯一标识，用作筛选示例值：xxx
GatherType	否	String	资源目录类别，枚举值如下： all - 全部 none - 未归集示例值：all
Sort	否	String	排序字段，枚举值如下： realCost - 折后总价 cashPayAmount - 现金金额 voucherPayAmount - 代金券金额 incentivePayAmount - 赠送金金额 transferPayAmount -分成金金额示例值：realCost
SortType	否	String	排序类型，枚举值如下： asc - 升序 desc - 降序示例值：asc
BusinessCodes.N	否	Array of String	产品编码，用作筛选示例值：p_cvm
ProductCodes.N	否	Array of String	子产品编码，用作筛选示例值：sp_cvm_c4
ItemCodes.N	否	Array of String	组件名称编码，用作筛选示例值：virtual_v_cvm_compute_c4
RegionIds.N	否	Array of Integer	地域ID，用作筛选示例值：4
InstanceTypes.N	否	Array of String	实例类型编码，用作筛选示例值：ri
PayModes.N	否	Array of String	计费模式编码，用作筛选示例值：prePay
OperateUins.N	否	Array of String	操作者UIN，用作筛选示例值：909619400
OwnerUins.N	否	Array of String	使用者UIN，用作筛选示例值：909619400
SearchKey	否	String	模糊搜索：支持标签、资源id、资源别名示例值：默认项目
Tag.N	否	Array of String	标签，用作筛选示例值：tagkey:tagValue
ProjectIds.N	否	Array of String	项目ID，用作筛选示例值：0
ActionTypes.N	否	Array of String	交易类型编码，用作筛选示例值：按量计费小时结

3. 输出参数

参数名称	类型	描述
RecordNum	Integer	总条数注意：此字段可能返回 null，表示取不到有效值。示例值：12
GatherResourceSummary	Array of GatherResourceSummary	资源归集汇总注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
LastUpdateTime	String	数据更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2022-11-14 00:00:00
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询分账账单资源归集汇总

查询分账账单资源归集汇总

输入示例

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

{
    "Month": "2024-02",
    "Limit": 1,
    "Offset": 0
}

输出示例

{
    "Response": {
        "GatherResourceSummary": [
            {
                "ActionType": "prepay_renew",
                "ActionTypeName": "包年包月续费",
                "AllocationType": 1,
                "BelongRule": null,
                "BelongTreeNodeUniqKey": {
                    "TreeNodeUniqKey": "909619400-6391dae9802da",
                    "TreeNodeUniqKeyName": "客户应用组"
                },
                "BusinessCode": "p_mongodb",
                "BusinessCodeName": "云数据库TencentDB for MongoDB",
                "CashPayAmount": "176.43419703",
                "IncentivePayAmount": "0.00000000",
                "InstanceType": "-",
                "InstanceTypeName": "-",
                "ItemCode": "sv_mongodb_mem_replica",
                "ItemCodeName": "文档数据库MongoDB-副本集-内存",
                "OperateUin": "909619400",
                "OtherRules": [],
                "OtherTreeNodeUniqKeys": [],
                "OwnerUin": "909619400",
                "PayMode": "prePay",
                "PayModeName": "包年包月",
                "PayerUin": "909619400",
                "ProductCode": "sp_mongodb_replica",
                "ProductCodeName": "云数据库MongoDB-副本集",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "RealTotalCost": "176.43419703",
                "RegionId": 1,
                "RegionName": "华南地区（广州）",
                "ResourceId": "cmgo-p46bysvb",
                "ResourceName": null,
                "RuleId": null,
                "RuleName": null,
                "SplitItemId": "",
                "SplitItemName": "",
                "Tag": null,
                "TransferPayAmount": "0.00000000",
                "TreeNodeUniqKey": "909619400-6391dae9802da",
                "TreeNodeUniqKeyName": "客户应用组",
                "VoucherPayAmount": "0.00000000"
            }
        ],
        "LastUpdateTime": "2024-03-02 13:17:07",
        "RecordNum": 3792,
        "RequestId": "b8bedd7a-da43-4cce-ab6e-2fa66ffe1455"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

上一篇: 查询分账账单费用趋势下一篇: 查询分账账单月概览