tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeBillSummaryByRegion

最后更新时间：2023-10-26 09:38:32

    1. API Description

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

    Gets the bill summarized according to region

    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: DescribeBillSummaryByRegion.
    Version Yes String Common Params. The value used for this API: 2018-07-09.
    Region No String Common Params. This parameter is not required.
    BeginTime Yes String The value must be of the same month as EndTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018.
    EndTime Yes String The value must be of the same month as BeginTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018.
    PayerUin No String Queries bill data user's UIN

    3. Output Parameters

    Parameter Name Type Description
    Ready Integer Indicates whether the data is ready. 0: Not ready. 1: Ready. If Ready is 0, it indicates that the current UIN is initializing billing for the first time. Wait for 5-10 minutes and try again.
    SummaryOverview Array of RegionSummaryOverviewItem Detailed cost distribution for all regions
    Note: This field may return null, indicating that no valid value was found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the bill summarized by region

    This example shows you how to get the bill summarized by region.

    Input Example

    POST / HTTP/1.1Host: billing.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBillSummaryByRegion<Common request parameters>{    "EndTime": "2018-11",    "BeginTime": "2018-11"}

    Output Example

    {
    "Response": {
        "Ready": 1,
        "SummaryOverview": [
            {
                "RegionId": "1",
                "RealTotalCost": "100631.85486247",
                "TotalCost": "101708.25486247",
                "CashPayAmount": "2922.91140386",
                "IncentivePayAmount": "97708.94345861",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "55.61",
                "BillMonth": "2021-11",
                "RegionName": "South China (Guangzhou)"
            },
            {
                "RegionId": "8",
                "RealTotalCost": "52596.91309090",
                "TotalCost": "52596.91309090",
                "CashPayAmount": "64.99381195",
                "IncentivePayAmount": "52531.91927895",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "29.07",
                "BillMonth": "2021-11",
                "RegionName": "North China (Beijing)"
            },
            {
                "RegionId": "4",
                "RealTotalCost": "27731.41174702",
                "TotalCost": "27731.41174702",
                "CashPayAmount": "71.09880801",
                "IncentivePayAmount": "27660.31293901",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "15.32",
                "BillMonth": "2021-11",
                "RegionName": "East China (Shanghai)"
            },
            {
                "RegionId": "0",
                "RealTotalCost": "-5.24970039",
                "TotalCost": "-5.24970039",
                "CashPayAmount": "-3059.00402382",
                "IncentivePayAmount": "3053.75432343",
                "VoucherPayAmount": "0.00000000",
                "TransferPayAmount": "0.00000000",
                "RealTotalCostRatio": "0.00",
                "BillMonth": "2021-11",
                "RegionName": "Other"
            }
        ],
        "RequestId": "0053df4c-c08d-4f43-bcaf-e181fc501167"
    }
}

    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
    InternalError Internal error.
    InternalError.GatewayError Gateway error.
    InternalError.UnknownError Undefined exception.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Invalid parameter value.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款