API
  • History
  • Introduction
  • API Category
  • Making API Requests
    • Request Structure
    • Common Params
    • Signature v3
    • Signature
    • Responses
  • Site APIs
    • CreateZone
    • DescribeIdentifications
    • ModifyZone
    • DeleteZone
    • ModifyZoneStatus
    • CheckCnameStatus
    • IdentifyZone
    • DescribeZones
    • VerifyOwnership
    • ExportZoneConfig
    • ImportZoneConfig
    • DescribeZoneConfigImportResult
  • Acceleration Domain Management APIs
    • CreateAccelerationDomain
    • DescribeAccelerationDomains
    • ModifyAccelerationDomain
    • ModifyAccelerationDomainStatuses
    • DeleteAccelerationDomains
    • CreateSharedCNAME
    • BindSharedCNAME
    • DeleteSharedCNAME
  • Site Acceleration Configuration APIs
    • CreateRule
    • DeleteRules
    • DescribeHostsSetting
    • DescribeRules
    • DescribeRulesSetting
    • DescribeZoneSetting
    • ModifyRule
    • ModifyZoneSetting
  • Edge Function APIs
    • CreateFunction
    • DescribeFunctions
    • ModifyFunction
    • CreateFunctionRule
    • DeleteFunction
    • DescribeFunctionRules
    • ModifyFunctionRule
    • ModifyFunctionRulePriority
    • DeleteFunctionRules
    • DescribeFunctionRuntimeEnvironment
    • HandleFunctionRuntimeEnvironment
  • Alias Domain APIs
    • CreateAliasDomain
    • DescribeAliasDomains
    • ModifyAliasDomain
    • ModifyAliasDomainStatus
    • DeleteAliasDomain
  • Security Configuration APIs
    • CreateSecurityIPGroup
    • DescribeSecurityIPGroup
    • ModifySecurityIPGroup
    • DeleteSecurityIPGroup
    • DescribeOriginProtection
    • DescribeSecurityTemplateBindings
    • ModifySecurityPolicy
    • BindSecurityTemplateToEntity
    • DescribeSecurityIPGroupInfo
  • Layer 4 Application Proxy APIs
    • CreateL4Proxy
    • ModifyL4Proxy
    • ModifyL4ProxyStatus
    • DescribeL4Proxy
    • DeleteL4Proxy
    • CreateL4ProxyRules
    • ModifyL4ProxyRules
    • ModifyL4ProxyRulesStatus
    • DescribeL4ProxyRules
    • DeleteL4ProxyRules
    • CreateApplicationProxy
    • ModifyApplicationProxy
    • ModifyApplicationProxyStatus
    • DescribeApplicationProxies
    • DeleteApplicationProxy
    • CreateApplicationProxyRule
    • ModifyApplicationProxyRule
    • ModifyApplicationProxyRuleStatus
    • DeleteApplicationProxyRule
  • Content Management APIs
    • CreatePurgeTask
    • DescribePurgeTasks
    • CreatePrefetchTask
    • DescribePrefetchTasks
    • DescribeContentQuota
  • Data Analysis APIs
    • DescribeDDoSAttackData
    • DescribeDDoSAttackEvent
    • DescribeDDoSAttackTopData
    • DescribeOverviewL7Data
    • DescribeTimingL4Data
    • DescribeTimingL7AnalysisData
    • DescribeTopL7AnalysisData
    • DescribeTimingL7CacheData
    • DescribeTopL7CacheData
  • Log Service APIs
    • DownloadL7Logs
    • DownloadL4Logs
    • CreateCLSIndex
    • CreateRealtimeLogDeliveryTask
    • ModifyRealtimeLogDeliveryTask
    • DeleteRealtimeLogDeliveryTask
    • DescribeRealtimeLogDeliveryTasks
  • Billing APIs
    • CreatePlan
    • UpgradePlan
    • RenewPlan
    • ModifyPlan
    • IncreasePlanQuota
    • DestroyPlan
    • CreatePlanForZone
    • BindZoneToPlan
    • DescribeBillingData
    • DescribeAvailablePlans
  • Certificate APIs
    • DescribeDefaultCertificates
    • ModifyHostsCertificate
  • Load Balancing APIs
    • CreateOriginGroup
    • ModifyOriginGroup
    • DeleteOriginGroup
    • DescribeOriginGroup
    • CreateLoadBalancer
    • ModifyLoadBalancer
    • DeleteLoadBalancer
    • DescribeLoadBalancerList
    • DescribeOriginGroupHealthStatus
  • Custom Response Page APIs
    • CreateCustomizeErrorPage
    • DescribeCustomErrorPages
    • ModifyCustomErrorPage
    • DeleteCustomErrorPage
  • DNS Record APIs
    • CreateDnsRecord
    • DeleteDnsRecords
    • DescribeDnsRecords
    • ModifyDnsRecordsStatus
    • ModifyDnsRecords
  • Diagnostic Tool APIs
    • DescribeIPRegion
  • Version Management APIs
    • CreateConfigGroupVersion
    • DeployConfigGroupVersion
    • DescribeConfigGroupVersionDetail
    • DescribeConfigGroupVersions
    • DescribeDeployHistory
    • DescribeEnvironments
  • Data Types
  • Error Codes

DescribeBillingData

1. API Description

Domain name for API request: teo.intl.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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeBillingData.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
StartTimeYesTimestamp ISO8601The start time.
EndTimeYesTimestamp ISO8601End time. the query time range (EndTime - StartTime) must be less than or equal to 31 days.
ZoneIds.NYesArray of StringSite ID set. this parameter is required. a maximum of 100 site ids can be imported. use * to query data for all sites under the tencent cloud root account. querying account-level data requires permissions for all site resources in this api.
MetricNameYesStringMetric list. values as follows:.
l4/l7 acceleration traffic:
  • acc_flux: specifies content acceleration traffic in bytes.
  • smt_flux: specifies smart acceleration traffic in bytes.
  • l4_flux: specifies layer 4 acceleration traffic in bytes.
  • sec_flux: specifies independent protection traffic in bytes.
  • zxctg_flux: specifies network optimization traffic in the chinese mainland in bytes.

  • l4/l7 acceleration bandwidth:
  • acc_bandwidth: specifies content acceleration bandwidth in bps.
  • smt_bandwidth: specifies intelligent acceleration bandwidth in bps.
  • l4_bandwidth: specifies layer 4 acceleration bandwidth in bps.
  • sec_bandwidth: specifies exclusive protection bandwidth in bps.
  • zxctg_bandwidth: specifies network optimization bandwidth in the chinese mainland in bps.

  • HTTP/HTTPS security requests:
  • sec_request_clean: specifies HTTP/HTTPS requests by count.

  • vas usage:
  • smt_request_clean: specifies intelligent acceleration requests by count.
  • quic_request: specifies quic requests by count.
  • bot_request_clean: specifies bot requests by count.
  • cls_count: specifies the number of real-time log pushes by count.
  • ddos_bandwidth: specifies elastic ddos protection bandwidth in bps.

  • edge computing usage:
  • edgefunction_request: specifies the number of edge function requests by count.
  • edgefunction_cpu_time: specifies edge function cpu processing time in milliseconds.
  • .
    Media processing usage:
  • total_transcode: all specification audio, video jit transcoding, repackaging duration, in seconds;
  • remux: repackaging duration, in seconds;
  • transcode_audio: audio transcoding duration, in seconds;
  • transcode_H264_SD: H.264 encoded standard-definition video (short side ≤ 480 px) duration, in seconds;
  • transcode_H264_HD: H.264 encoded high-definition video (short side ≤ 720 px) duration, in seconds;
  • transcode_H264_FHD: H.264 encoded full HD video (short side ≤ 1080 px) duration, in seconds;
  • transcode_H264_2K: H.264 encoded 2K video (short side ≤ 1440 px) duration, in seconds.
  • .
    IntervalYesStringTime granularity of the query. Valid values:
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
  • Filters.NNoArray of BillingDataFilterFilter criteria. the detailed values of filter criteria are as follows:.
  • host: specifies the domain name to filter by. example value: test.example.com.
  • .
  • proxy-id: specifies the l4 proxy instance id for filtering. example value: sid-2rugn89bkla9.
  • .
  • region-id: Filter by billing region. Options:
    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


  • Specifies that BillingDataFilter with the same Type have an "or" relationship with each other, while those with different Type have an "and" relationship between them.
    GroupBy.NNoArray of StringGrouping aggregate dimension. a maximum of two dimensions can be grouped simultaneously. values are as follows:
  • zone-id: group by site id. if the content identifier functionality is used, priority is given to grouping by content identifier;
  • host: group by domain name;
  • proxy-id: group by layer 4 proxy instance id;
  • region-id: group by billing region.
  • .

    3. Output Parameters

    Parameter NameTypeDescription
    DataArray of BillingDataData point list.
    Note: This field may return null, which indicates a failure to obtain a valid value.
    RequestIdStringThe 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 for Specified Site in Specified Billing Region

    This example shows you how to query the billing usage of content acceleration traffic for a specified zone-id in a designated region-id with daily granularity.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.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
                }
            ]
        }
    }
    

    Example2 Querying Content Acceleration Traffic of Specified Sites Grouped by Site ID

    This example shows you how to query the billing usage of content acceleration traffic for a specified zone-id, grouping by zone-id with daily granularity.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeBillingData
    <Common request parameters>
    
    {
        "StartTime": "2025-07-01T00:00:00+08:00",
        "EndTime": "2025-07-02T23:59:59+08:00",
        "Interval": "day",
        "MetricName": "acc_flux",
        "ZoneIds": [
            "zone-2m2gq4dnpmd2",
            "zone-30hqppzribht"
        ],
        "GroupBy": [
            "zone-id"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "d2174285-8aac-4cdc-bc06-d81f2f6520da",
            "Data": [
                {
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 0,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 2751240612,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 0,
                    "ZoneId": "zone-30hqppzribht"
                },
                {
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 68443435,
                    "ZoneId": "zone-30hqppzribht"
                }
            ]
        }
    }
    

    Example3 Querying Content Acceleration Traffic for Specified Site by Domain Group

    This example shows you how to query specified content acceleration traffic billing volume by domain name with daily granularity for a given zone-id.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeBillingData
    <Common request parameters>
    
    {
        "StartTime": "2025-07-01T00:00:00+08:00",
        "EndTime": "2025-07-02T23:59:59+08:00",
        "Interval": "day",
        "MetricName": "acc_flux",
        "ZoneIds": [
            "zone-2m2gq4dnpmd2",
            "zone-30hqppzribht"
        ],
        "GroupBy": [
            "host"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "d2174285-8aac-4cdc-bc06-d81f2f6520da",
            "Data": [
                {
                    "Host": "test1.example.com",
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 1387001003,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "Host": "test1.example.com",
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 1390529805,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "Host": "test2.example.com",
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 2879078,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "Host": "test2.example.com",
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 2889084,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                }
            ]
        }
    }
    

    Example4 Querying Content Acceleration Traffic of Specified Site and Grouping by Site ID and Billing Region

    This example shows you how to query specified zone-id content acceleration traffic billing volume, grouping by zone-id and billing region with daily granularity.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeBillingData
    <Common request parameters>
    
    {
        "StartTime": "2025-07-01T00:00:00+08:00",
        "EndTime": "2025-07-02T23:59:59+08:00",
        "Interval": "day",
        "MetricName": "acc_flux",
        "ZoneIds": [
            "zone-2m2gq4dnpmd2",
            "zone-30hqppzribht"
        ],
        "GroupBy": [
            "zone-id",
            "region-id"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "d2174285-8aac-4cdc-bc06-d81f2f6520da",
            "Data": [
                {
                    "RegionId": "SA",
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 549591531,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "RegionId": "SA",
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 549591531,
                    "ZoneId": "zone-2m2gq4dnpmd2"
                },
                {
                    "RegionId": "MidEast",
                    "Time": "2025-06-30T16:00:00Z",
                    "Value": 549591531,
                    "ZoneId": "zone-30hqppzribht"
                },
                {
                    "RegionId": "MidEast",
                    "Time": "2025-07-01T16:00:00Z",
                    "Value": 549591531,
                    "ZoneId": "zone-30hqppzribht"
                }
            ]
        }
    }
    

    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

    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 CodeDescription
    InternalError.ProxyServerAn unknown error occurred in the backend server.
    InvalidParameter.GroupByLimitExceededThe GroupBy parameter exceeds the limit.
    InvalidParameter.InvalidIntervalInvalid interval. The value should be either [min 5min hour day].
    InvalidParameter.InvalidMetricThe query dimension is invalid.
    InvalidParameter.ZoneHasNotBeenBoundToPlanThe zone is not bound to a package.