All Documents
Current Document

Content is empty

If you don't find the content you expect, please try another search term

Documentation

DescribeBillSummary

Last updated:2021-07-16 15:31:59

DescribeBillSummary

You can call this operation to query the bill summary by product. Note: You can query only the bills of the same month.

Request parameters

Parameter Type Required Length (number of characters) Format Description
Action String Yes Fixed value The operation that you want to perform. Set the value to DescribeBillSummary.
Version String Yes Fixed value The version number of the API operation. Set the value to 2019-07-19.
BillStartTime String Yes yyyy-MM-dd HH:mm:ss The start time of the bill. This parameter is required. The query result contains this time.
BillEndTime String Yes yyyy-MM-dd HH:mm:ss The end time of the bill. This parameter is required. The query result does not contain this time. The bill end time must be in the same month as the bill start time.
ProductCode String No The code of the product. Example: VM_GROUP. This parameter is optional. If you do not specify this parameter, bills of all products are returned. For more information about product codes, see DescribeProductCode .


Response parameters

Parameter Type Description
RequestId String The ID of the request.
TotalCost String The total consumption amount.
ProductSummarySet ProductSummary array The bill summary.


Error codes

Error code Error message HTTP status code Description
InvalidParameter There is one or more invalid parameter(%s). 400 The error message returned because the %s parameter is invalid. For more information about the parameter, see %s.
MissingParameter A required parameter for the specified action is not supplied. 400 The error message returned because the %s parameter is not specified. For more information about the parameter, see %s.


Successful call examples

Sample requests

http://krtpay.api.ksyun.com/?Action=DescribeBillSummary
&Version=2019-07-19
&BillStartTime=2019-07-12 20:00:00
&BillEndTime=2019-07-16 00:00:00
&ProductCode=VM_GROUP
&Common request parameters

Sample success responses

  • XML format
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <DescribeBillSummaryResponse>
        <RequestId>5e831fd0-521f-4afe-bb92-1328ce38311a</RequestId>
        <TotalCost>34.20</TotalCost>
        <ProductSummarySet>
            <Item>
                <code>VM_GROUP</code>
                <Name>KEC</Name>
                <Cost>34.20</Cost>
            </Item>
        </ProductSummarySet>
    </DescribeBillSummaryResponse>
  • JSON format
    {
        "RequestId": "741e499d-7a46-4af5-aacd-f56e419e4fcf",
        "TotalCost": "34.20",
        "ProductSummarySet": [
            {
                "Name": "KEC",
                "Code": "VM_GROUP",
                "Cost": "34.20"
            }
        ]
    }
On this page
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback