All Documents
Current Document

Content is empty

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

Documentation

getMonthConsume

Last updated:2021-07-16 15:32:00

getMonthConsume

You can call this operation to query the summary of the estimated consumption by product.
Note: You can query the summary only of the estimated consumption in the previous and current months.

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 getMonthConsume.
Version String Yes Fixed value The version number of the API operation. Set the value to 2018-06-01.
BillMonth String Yes YYYY-MM The billing month. This parameter is required.


Response parameters

Parameter Type Description
RequestId String The ID of the request.
BeginDate String The start date of the estimated consumption.
EndDate String The end date of the estimated consumption.
MonthBillSet MonthConsume array The summary of the estimated consumption bill in the month.


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.
Forbidden Request user %s forbidden request this api" 400 The error message returned because the user denies the API request. For more information about the user ID, see %s.
Server unavailable Server error 500 The error message returned because exceptions occur on the backend server.


Successful call examples

Sample requests

https://bill.api.ksyun.com/?Action=getMonthConsume
&Version=2018-06-01
&BillMonth=2019-08
&Common request parameters

Sample success responses

  • XML format
<GetMonthConsumeResponse>
    <BeginDate>2019-08-01</BeginDate>
    <EndDate>2019-08-28</EndDate>
    <RequestId>9a12cb1f-85bc-4a69-a4f5-5f669f22d8eb</RequestId>
    <MonthBillSet>
        <Item>
            <BillProductSet>
                <Item>
                    <code>KSS</code>
                    <Cost>8207703.66</Cost>
                    <Name>KSS</Name>
                </Item>
            </BillProductSet>
            <BillId>KSYZD0073406772201908</BillId>
            <Sum>8207703.66</Sum>
            <BillType>postpay</BillType>
            <BillMonth>2019-08</BillMonth>
        </Item>
    </MonthBillSet>
</GetMonthConsumeResponse>
  • JSON format
{
    "BeginDate": "2019-08-01",
    "EndDate": "2019-08-28",
    "RequestId": "9a12cb1f-85bc-4a69-a4f5-5f669f22d8eb",
    "MonthBillSet": [
        {
            "BillProductSet": [
                {
                    "Code": "KSS",
                    "Cost": 8207703.66,
                    "Name": "KSS"
                }
            ],
            "BillId": "KSYZD0073406772201908",
            "Sum": 8207703.66,
            "BillType": "postpay",
            "BillMonth": "2019-08"
        }
    ]
}
On this page
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback