Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeBillingData

Last updated: 2024-04-09 10:26:16

Download PDF

1. API Description

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

This API is used to query billing data.

A maximum of 50 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: DescribeBillingData.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
StartTime	Yes	Timestamp ISO8601	Start time of the query.
EndTime	Yes	Timestamp ISO8601	End time of the query.
ZoneIds.N	Yes	Array of String	Zone ID set. This parameter is required.
MetricName	Yes	String	Indicator list. Valid values: acc_flux: Content acceleration traffic, in bytes; smt_flux: Smart acceleration traffic, in bytes; l4_flux: Layer 4 acceleration traffic, in bytes; sec_flux: Exclusive DDoS mitigation traffic, in bytes; zxctg_flux: Cross-MLC-border acceleration traffic, in bytes; acc_bandwidth: Content acceleration bandwidth, in bps; smt_bandwidth: Smart acceleration bandwidth, in bps; l4_bandwidth: Layer 4 acceleration bandwidth, in bps; sec_bandwidth: Exclusive DDoS mitigation bandwidth, in bps; zxctg_bandwidth: Cross-MLC-border acceleration bandwidth, in bps; sec_request_clean: HTTP/HTTPS requests, in count; smt_request_clean: Smart acceleration requests, in count; quic_request: QUIC requests, in count; bot_request_clean: Bot requests, in count; cls_count: Real-time log delivery log counts, in count; ddos_bandwidth: Exclusive DDoS mitigation elastic bandwidth, in bps.
Interval	Yes	String	Query granularity. Valid values: 5min: 5-minute granularity; hour: 1-hour granularity; day: 1-day granularity.
Filters.N	No	Array of BillingDataFilter	Filter. The detailed filters are as follows: host: Filter by Domain Name. Example: test.example.com. proxy-id: Filter by Layer 4 Proxy Instance ID. Example: sid-2rugn89bkla9. region-id: Filter by Billing Region.Options are: CH: Chinese mainland AF: Africa AS1: Asia-Pacific Region 1 AS2: Asia-Pacific Region 2 AS3: Asia-Pacific Region 3 EU: Europe MidEast: Middle East NA: North America SA: South America

3. Output Parameters

Parameter Name	Type	Description
Data	Array of BillingData	Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying content acceleration traffic in the specified zone and billing region

This example shows you how to query the billing volume of content acceleration traffic with a specific zone ID and region ID on a daily granularity.

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingData
<Common Request Parameters>

{
    "StartTime": "2024-01-01T00:00:00+08:00",
    "EndTime": "2024-01-24T03:20:00+08:00",
    "Interval": "day",
    "MetricName": "acc_flux",
    "Filters": [
        {
            "Type": "region-id",
            "Value": "MidEast"
        }
    ],
    "ZoneIds": [
        "zone-2smdfso9dr58"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "457e8933-4296-4878-9a7f-fb888559e29e",
        "Data": [
            {
                "Time": "2023-12-31T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-01T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-02T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-03T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-04T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-05T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-06T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-07T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-08T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-09T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-10T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-11T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-12T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-13T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-14T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-15T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-16T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-17T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-18T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-19T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-20T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-21T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-22T16:00:00Z",
                "Value": 0
            },
            {
                "Time": "2024-01-23T16:00:00Z",
                "Value": 0
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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.ProxyServer	An unknown error occurred in the backend server.
InvalidParameter.InvalidInterval	Invalid interval. The value should be either [min 5min hour day].
InvalidParameter.InvalidMetric	The query dimension is invalid.
InvalidParameter.ZoneHasNotBeenBoundToPlan	The zone is not bound to a package.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages

DescribeBillingData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying content acceleration traffic in the specified zone and billing region

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeBillingData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying content acceleration traffic in the specified zone and billing region

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?