Documentation|Tencent Cloud

search by keyword

Recent Pages

DescribeBillResourceSummary

Last updated: 2020-07-10 12:01:55

1. API Description

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

This API is used to query bill resources summary.

A maximum of 5 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 parameter. The value used for this API: DescribeBillResourceSummary.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-09.
Region	No	String	Common parameter. This parameter is not required for this API.
Offset	Yes	Integer	Offset
Limit	Yes	Integer	Quantity, maximum is 1000
PeriodType	Yes	String	The period type. byUsedTime: By usage period; byPayTime: by payment period. Must be the same as the period of the current monthly bill of the Billing Center. You can check your bill statistics period type at the top of the Bill Overview page.
Month	Yes	String	Month; format: yyyy-mm. This value cannot be earlier than the month when Bill 2.0 is enabled. Last 24 months data are available.
NeedRecordNum	No	Integer	Indicates whether or not the total number of records of accessing the list is required, used for frontend pages. 1 = yes, 0 = no

3. Output Parameters

Parameter Name	Type	Description
ResourceSummarySet	Array of BillResourceSummary	Resource summary list
Total	Integer	Total number of resource summary lists 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 breakdown of a bill

Input Example

https://billing.tencentcloudapi.com/?Action=DescribeBillResourceSummary
&Month=2018-08
&PeriodType=byPayTime
&Offset=0
&Limit=1
&ActionType=Pay-as-you-go deduction
&<common request parameters>

Output Example

{
  "Response": {
    "ResourceSummarySet": [
      {
        "PayerUin": "2384822478",
        "OwnerUin": "-",
        "OperateUin": "-",
        "BusinessCodeName": "Cloud Virtual Machine",
        "ProductCodeName": "-",
        "PayModeName": "Pay-as-you-go",
        "ProjectName": "Default project",
        "RegionName": "North America (Toronto)",
        "ZoneName": "Toronto Zone 1",
        "ResourceId": "ins-o0z91q0p",
        "ResourceName": "Unnamed",
        "ActionTypeName": "Pay-as-you-go deduction",
        "OrderId": "-",
        "PayTime": "-",
        "FeeBeginTime": "2018-08-28 21:00:00",
        "FeeEndTime": "2018-08-28 21:00:02",
        "ConfigDesc": "CPU: 1 core; memory: 1GiB; system disk: 50GB; ",
        "ExtendField1": "-",
        "ExtendField2": "-",
        "ExtendField3": "-",
        "ExtendField4": "-",
        "ExtendField5": "-",
        "TotalCost": "155.04348856",
        "Discount": "0.6",
        "ReduceType": "Discount",
        "RealTotalCost": "93.039956",
        "VoucherPayAmount": "0",
        "CashPayAmount": "93.039956",
        "IncentivePayAmount": "0",
        "BusinessCode": "p_cvm",
        "ProductCode": "sp_cvm_s1",
        "RegionId": "1"
      }
    ],
    "Total": 103,
    "RequestId": "02917e78-03af-4a7a-855d-d48705108ab2"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.