tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBillSummary

Last updated: 2024-04-25 10:05:34

1. API Description

Domain name for API request: intlpartnersmgt.tencentcloudapi.com.

External API for the L1 billing of the customer billing center

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeBillSummary.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
Month Yes String Bill month in the format of "yyyy-mm".
GroupType Yes String Billing dimension. Optional parameters: product, project, tag
TagKey.N No Array of String Tag value list

3. Output Parameters

Parameter Name Type Description
SummaryDetail Array of SummaryDetails Detailed summary by billing dimensionNote: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Summarizing DescribeBillSummary by tag dimension

This example shows you how to view the API and tag dimension statistics in customer billing center L1 bill by customers.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
<Public request parameters>{
    "Month": "2023-10",
    "GroupType": "tag",
    "TagKey": [
        "abc"
    ]
}

Output Example

{
    "Response": {
        "SummaryDetail": [
            {
                "Business": [
                    {
                        "BusinessCodeName": "CVM Dedicated Host",
                        "BusinessCode": "p_cdh",
                        "OriginalCost": "12.11",
                        "VoucherPayAmount": "1.1",
                        "RICost": "0.1",
                        "TotalCost": "12.1"
                    }
                ],
                "OriginalCost": "12.1",
                "VoucherPayAmount": "1.1",
                "RICost": "1.1",
                "TotalCost": "2.2",
                "GroupKey": "abc",
                "GroupValue": "default"
            }
        ],
        "RequestId": "abc"
    }
}

Example2 Summarizing DescribeBillSummary by project dimension

This example shows you how to view the API and project dimension statistics in customer billing center L1 bill by customers.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
< Public request parameters>{
    "Month": "2023-10",
    "GroupType": "project"
}

Output Example

{
    "Response": {
        "SummaryDetail": [
            {
                "Business": [
                    {
                        "BusinessCodeName": "cloud block storage",
                        "BusinessCode": "p_cbs",
                        "OriginalCost": "148.40000000",
                        "VoucherPayAmount": "129.70000000",
                        "RICost": "0.00000000",
                        "TotalCost": "18.70000000"
                    }
                ],
                "OriginalCost": "148.40000000",
                "VoucherPayAmount": "129.70000000",
                "RICost": "0.00000000",
                "TotalCost": "18.70000000",
                "GroupKey": "0",
                "GroupValue": "default"
            }
        ],
        "RequestId": "abc"
    }
}

Example3 Summarizing DescribeBillSummary by product dimension

This example shows you how to view the API and product dimension statistics in customer billing center L1 bill by customers.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummary
< Public request parameters>{
    "Month": "2023-10",
    "GroupType": "product"
}

Output Example

{
    "Response": {
        "SummaryDetail": [
            {
                "Business": null,
                "OriginalCost": "148.40000000",
                "VoucherPayAmount": "129.70000000",
                "RICost": "0.00000000",
                "TotalCost": "18.70000000",
                "GroupKey": "p_cbs",
                "GroupValue": "cloud block storage"
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter
InvalidParameterValue.InvalidDimension The dimension data entered is incorrect.
InvalidParameterValue.InvalidMonth Incorrect month value
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy