DescribeBillDetail

1. API Description

This API is used to query detailed informations on monthly spend by order No. or by resource ID.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
pageNum	No	Integer	Number of pages returned. Default value: 1.
pageSize	No	Integer	Number of items in the current page result. Maximum value: 5000.
billMonthly	No	Integer	Month of the bill. Default value: the current month. Format: yyyyMM.
orderSn	No	String	Order No.
resourceId	No	String	Resource ID (Instance ID).

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalSpend	Double	Total spend.
totalVoucher	Double	Total voucher.
totalCash	Double	Total cash.
totalRefund	Double	Total refund.
totalCount	Integer	Number of bills meeting the filtering conditions.
dataSet	Array of BillingDetailInfo	Information on bills.

4. Code Example

Example

Query information on bills.

POST /api/v2/zbc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeBillDetail
<Common Request Params>

Request:
{
  "billMonthly": 202307,
  "pageSize": 2,
  "pageNum": 1,
  "resourceId":"945345672712820433"
}

Response:
{
    "requestId": "T2A96D54A-6A16-41B7-A991-A6691B4F32BA",
    "response": {
        "totalSpend": 16114.870000,
        "requestId": "T2A96D54A-6A16-41B7-A991-A6691B4F32BA",
        "totalVoucher": 306.320000,
        "totalRefund": 8215.730000,
        "totalCash": 24024.280000,
        "totalCount": 122,
        "dataSet": [
            {
                "resourceId": "938831989325181400",
                "product": "Compute",
                "amount": 83.260000,
                "billingMode": "Time pricing",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "938832035772898264",
                "voucher": 40.410000,
                "deductionTime": "2023-07-21T02:00:00Z",
                "label": "M9Y-AMS-D-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "AMS-D",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-19T08:17:33Z",
                "endTime": "2023-07-21T02:30:16Z",
                "cash": 42.850000
            },
            {
                "resourceId": "938125503838038232",
                "product": "Compute",
                "amount": 6.240000,
                "billingMode": "Time pricing",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "938125516571936216",
                "voucher": 1.820000,
                "deductionTime": "2023-07-31T23:00:00Z",
                "label": "98.96.193.64/29",
                "billMonthly": 202307,
                "productSubitem": "Public Virtual Interface",
                "location": "DFW2A",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-18T09:00:00Z",
                "endTime": "2023-07-31T23:59:59Z",
                "cash": 4.420000
            },
            {
                "resourceId": "938100010245951960",
                "product": "Compute",
                "amount": 44.500000,
                "billingMode": "Time pricing",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "938100046920946648",
                "voucher": 13.710000,
                "deductionTime": "2023-07-21T02:00:00Z",
                "label": "M9U-DFW-A-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "DFW-A",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-18T08:02:25Z",
                "endTime": "2023-07-21T02:27:52Z",
                "cash": 30.790000
            },
            {
                "resourceId": "938048288874041560",
                "product": "Compute",
                "amount": 0.080000,
                "billingMode": "Time pricing",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "938048297967295192",
                "voucher": 0.000000,
                "deductionTime": "2023-07-18T06:14:33Z",
                "label": "98.96.193.64/26",
                "billMonthly": 202307,
                "productSubitem": "Public Virtual Interface",
                "location": "DFW2A",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-18T06:14:33Z",
                "endTime": "2023-07-18T06:52:22Z",
                "cash": 0.080000
            },
            {
                "resourceId": "937380292249791960",
                "product": "Compute",
                "amount": -274.080000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "937382571921115608",
                "voucher": 0.000000,
                "deductionTime": "2023-07-17T08:11:55Z",
                "label": "S8O-AMS-C-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "AMS-C",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-17T08:11:46Z",
                "endTime": "2023-07-17T08:11:46Z",
                "cash": -274.080000
            },
            {
                "resourceId": "937369698889106392",
                "product": "Compute",
                "amount": -284.050000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "937382151005936600",
                "voucher": 0.000000,
                "deductionTime": "2023-07-17T08:11:05Z",
                "label": "S8O-AMS-C-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "AMS-C",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-17T08:10:11Z",
                "endTime": "2023-07-17T08:10:11Z",
                "cash": -284.050000
            },
            {
                "resourceId": "937380292249791960",
                "product": "Compute",
                "amount": 284.050000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "937380322801093848",
                "voucher": 0.000000,
                "deductionTime": "2023-07-17T08:08:18Z",
                "label": "S8O-AMS-C-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "AMS-C",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-17T08:08:18Z",
                "endTime": "2023-08-16T08:08:18Z",
                "cash": 284.050000
            },
            {
                "resourceId": "937369698889106392",
                "product": "Compute",
                "amount": 284.050000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "Default Resource Group",
                "orderSn": "937369744607029976",
                "voucher": 0.000000,
                "deductionTime": "2023-07-17T07:47:56Z",
                "label": "S8O-AMS-C-01",
                "billMonthly": 202307,
                "productSubitem": "Bare Metal Instance",
                "location": "AMS-C",
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "startTime": "2023-07-17T07:47:56Z",
                "endTime": "2023-08-16T07:47:56Z",
                "cash": 284.050000
            },
            {
                "resourceId": "828613802374214104",
                "product": "Compute",
                "amount": 2.850000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "test-resourceGroup",
                "orderSn": "937333418209845720",
                "voucher": 0.000000,
                "deductionTime": "2023-07-17T06:34:15Z",
                "label": "23.90.160.82",
                "billMonthly": 202307,
                "productSubitem": "Common elastic IPv4",
                "location": "AMS-C",
                "resourceGroupId": "ea0fa204-1f54-4dc6-863c-f385739921d8",
                "startTime": "2023-07-17T06:34:16Z",
                "endTime": "2023-08-16T06:34:16Z",
                "cash": 2.850000
            },
            {
                "resourceId": "762684305204841432",
                "product": "Zen VM",
                "amount": 19.000000,
                "billingMode": "PRE_PAID",
                "resourceGroupName": "",
                "orderSn": "936634808610589912",
                "voucher": 0.000000,
                "deductionTime": "2023-07-16T07:26:15Z",
                "label": "default-POC-20GB-01",
                "billMonthly": 202307,
                "productSubitem": "Virtual Elastic Disk",
                "location": "POC",
                "resourceGroupId": "",
                "startTime": "2023-07-16T07:26:15Z",
                "endTime": "2023-08-15T07:26:15Z",
                "cash": 19.000000
            }
        ]
    }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​​