tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBillingData

Last updated: 2023-12-01 16:39:48

    1. API Description

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

    This API is used to query billing data details.

    A maximum of 20 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: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    StartTime Yes Timestamp Start time of the query, e.g., 2018-09-04 10:40:00.
    The specified start time will be rounded down based on the granularity parameter Interval. For example, if you set the start time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
    The period between the start time and end time can be up to 90 days.
    EndTime Yes Timestamp End time of the query, e.g. 2018-09-04 10:40:00.
    The specified end time will be rounded down based on the granularity parameter Interval. For example, if you set the end time to 2018-09-04 10:40:00 with 1-hour granularity, the time will be rounded down to 2018-09-04 10:00:00.
    The period between the start time and end time can be up to 90 days.
    Interval No String Time granularity, which can be:
    min: 1-minute granularity. The query period cannot exceed 24 hours.
    5min: 5-minute granularity. The query range cannot exceed 31 days.
    hour: 1-hour granularity. The query period cannot exceed 31 days.
    day: 1-day granularity. The query period cannot exceed 31 days.

    min is not supported if the Area field is overseas.
    Domain No String Domain name whose billing data is to be queried
    Project No Integer Specifies the project ID to be queried. Check project ID in the console
    If the Domain parameter is passed in, the Proejct parameter is ignored. Only the billing data of the specified domain name is returned.
    Area No String Acceleration region whose billing data is to be queried:
    mainland: Regions within the Chinese mainland
    overseas: Regions outside the Chinese mainland
    If this parameter is left empty, mainland will be used by default
    District No Integer Country/region to be queried if Area is overseas
    To view codes of provinces or countries/regions, see Province Code Mappings
    If this parameter is left empty, all countries/regions will be queried
    Metric No String Billing statistics type
    flux: Bill by traffic
    bandwidth: Bill by bandwidth
    Default value: bandwidth
    Product No String Specifies the product to query, either cdn (default) or ecdn.
    TimeZone No String

    3. Output Parameters

    Parameter Name Type Description
    Interval String Time granularity, which is specified by the parameter passed in during the query:
    min: 1 minute
    5min: 5 minutes
    hour: 1 hour
    day: 1 day
    Data Array of ResourceBillingData Data details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying billing data

    Input Example

    https://cdn.tencentcloudapi.com/?Action=DescribeBillingData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "123",
        "Data": [
            {
                "Resource": "all",
                "BillingData": [
                    {
                        "Metric": "flux",
                        "DetailData": [
                            {
                                "Time": "2018-09-03 00:00:00",
                                "Value": 10
                            },
                            {
                                "Time": "2018-09-03 00:05:00",
                                "Value": 20
                            }
                        ],
                        "SummarizedData": {
                            "Name": "sum",
                            "Value": 30
                        }
                    }
                ]
            }
        ],
        "Interval": "5min"
    }
}

    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 Code Description
    InternalError.CamSystemError Authentication system internal error.
    InternalError.CdnConfigError Failed to update the domain name configuration.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnQuerySystemError Internal error. Please try again or contact the customer service for assistance.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.CostDataSystemError Billing data query internal error. Please submit a ticket for troubleshooting.
    InternalError.DataSystemError Error with the data query. Please submit a ticket for troubleshooting.
    InternalError.Error Service internal error. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InternalError.RouteError Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnHostInvalidParam Invalid domain name format. Please check and try again.
    InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.CdnStatInvalidDate Invalid date. Please see the sample date in the documentation.
    InvalidParameter.CdnStatInvalidMetric Invalid statistical type. Please see the sample statistical analysis in the documentation.
    InvalidParameter.CdnStatInvalidProjectId Incorrect project ID. Please check and try again.
    InvalidParameter.EcdnInterfaceError API internal error. Please try again or contact the customer service for assistance.
    ResourceNotFound.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.CdnProjectNotExists The project does not exist. Please check and try again.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    UnauthorizedOperation.CdnAccountUnauthorized The sub-account is unauthorized to query full data.
    UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
    UnauthorizedOperation.CdnProjectUnauthorized The project is not authorized for the sub-account.
    UnauthorizedOperation.CdnTagUnauthorized The sub-account has no access to the tag.
    UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
    UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta whitelist and thus have no permission to use this function.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy