tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeBillBandwidthAndFluxList

最后更新时间：2024-09-13 14:49:44

    1. API Description

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

    This API is used to query the data of billable bandwidth and traffic.

    A maximum of 100 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: DescribeBillBandwidthAndFluxList.
    Version Yes String Common Params. The value used for this API: 2018-08-01.
    Region No String Common Params. This parameter is not required for this API.
    StartTime Yes String The start time of the request, supports data query for the last three years, the gap between the start time and the end time cannot exceed one month. Interface request supports two time formats:
    1) YYYY-MM-DDThh:mm:ssZ: ISO time format, for details, see ISO Date Format Description
    2) YYYY-MM-DD hh:mm:ss: When using this format, it represents Beijing time by default.
    EndTime Yes String The end time of the request, supports data query for the last three years, the gap between the start time and the end time cannot exceed one month. Interface request supports two time formats:
    1) YYYY-MM-DDThh:mm:ssZ: ISO time format,for details,see ISO Date Format Description
    2) YYYY-MM-DD hh:mm:ss: When using this format, it represents Beijing time by default.
    PlayDomains.N No Array of String LVB playback domain name. If this parameter is left empty, full data will be queried.
    MainlandOrOversea No String Valid values:
    Mainland: query data for Mainland China,
    Oversea: query data for regions outside Mainland China,
    Default: query data for all regions.
    Note: LEB only supports querying data for all regions.
    Granularity No Integer Data granularity. Valid values:
    5: 5-minute granularity (the query time span should be within 1 day),
    60: 1-hour granularity (the query time span should be within one month),
    1440: 1-day granularity (the query time span should be within one month).
    Default value: 5.
    ServiceName No String Service name. Valid values: LVB, LEB. The sum of LVB and LEB usage will be returned if this parameter is left empty.
    RegionNames.N No Array of String Region. Valid values:
    China Mainland
    Asia Pacific I
    Asia Pacific II
    Asia Pacific III
    Europe
    North America
    South America
    Middle East
    Africa

    3. Output Parameters

    Parameter Name Type Description
    PeakBandwidthTime String Time point of peak bandwidth value in the format of yyyy-mm-dd HH:MM:SS.
    PeakBandwidth Float Peak bandwidth in Mbps.
    P95PeakBandwidthTime String Time point of 95th percentile bandwidth value in the format of yyyy-mm-dd HH:MM:SS.
    P95PeakBandwidth Float 95th percentile bandwidth in Mbps.
    SumFlux Float Total traffic in MB.
    DataInfoList Array of BillDataInfo Detailed data information.
    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 Sample request

    Input Example

    https://live.tencentcloudapi.com/?Action=DescribeBillBandwidthAndFluxList
&PlayDomains.0=5000.playdomain.com
&StartTime=2019-02-0100:00:00
&EndTime=2019-02-0100:10:00
&<Common request parameters>

    Output Example

    {
    "Response": {
        "P95PeakBandwidth": 117042.495,
        "P95PeakBandwidthTime": "2019-02-01 00:00:00",
        "DataInfoList": [
            {
                "Bandwidth": 117042.495,
                "Flux": 4389093.551,
                "Time": "2019-02-01 00:00:00",
                "PeakTime": "2019-02-01 00:00:00"
            },
            {
                "Bandwidth": 110364.995,
                "Flux": 4138687.32,
                "Time": "2019-02-01 00:05:00",
                "PeakTime": "2019-02-01 00:05:00"
            },
            {
                "Bandwidth": 99380.978,
                "Flux": 3726786.679,
                "Time": "2019-02-01 00:10:00",
                "PeakTime": "2019-02-01 00:10:00"
            }
        ],
        "PeakBandwidth": 117042.495,
        "PeakBandwidthTime": "2019-02-01 00:00:00",
        "RequestId": "f54e3deb-f318-4148-8a68-3c959642f9ec",
        "SumFlux": 12254567.55
    }
}

    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
    FailedOperation Operation failed.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameter missing.
    ResourceNotFound.ForbidService You are blocked.
    ResourceNotFound.FreezeService Service suspended.
    ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
    ResourceNotFound.UserDisableService You disabled the service.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款