Last updated: 2021-01-28 19:34:32

    1. API Description

    Domain name for API request:

    This API is used to query the downstream playback data by district and ISP.

    A maximum of 200 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 parameter. The value used for this API: DescribeGroupProIspPlayInfoList.
    Version Yes String Common parameter. The value used for this API: 2018-08-01.
    Region No String Common parameter. This parameter is not required for this API.
    StartTime Yes String Start time point in the format of yyyy-mm-dd HH:MM:SS.
    EndTime Yes String End time point in the format of yyyy-mm-dd HH:MM:SS
    The time span is (0,3 hours]. Data for the last month can be queried.
    PlayDomains.N No Array of String Playback domain name. If this parameter is left empty, full data will be queried.
    ProvinceNames.N No Array of String District list. If this parameter is left empty, data for all districts will be returned.
    IspNames.N No Array of String ISP list. If this parameter is left empty, data of all ISPs will be returned.
    MainlandOrOversea No String Within or outside Mainland China. Valid values: Mainland (data for Mainland China), Oversea (data for regions outside Mainland China). If this parameter is left empty, data for all regions will be queried.

    3. Output Parameters

    Parameter Name Type Description
    DataInfoList Array of GroupProIspDataInfo Data content.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    District/ISP mapping table.

    Input Example
    &StartTime=2019-03-29 09:00:00
    &EndTime=2019-03-29 09:10:00
    &<Common request parameters>

    Output Example

      "Response": {
        "DataInfoList": [
            "DetailInfoList": [
                "Bandwidth": 863.073,
                "Flux": 6473.05,
                "Online": 540,
                "Request": 449,
                "Time": "2019-03-29 09:00:00"
                "Bandwidth": 891.49,
                "Flux": 6686.173,
                "Online": 524,
                "Request": 455,
                "Time": "2019-03-29 09:05:00"
                "Bandwidth": 847.715,
                "Flux": 6357.859,
                "Online": 612,
                "Request": 578,
                "Time": "2019-03-29 09:10:00"
            "IspName": "China Telecom",
            "ProvinceName": "Guangdong"
            "DetailInfoList": [
                "Bandwidth": 213.405,
                "Flux": 1600.537,
                "Online": 132,
                "Request": 184,
                "Time": "2019-03-29 09:00:00"
                "Bandwidth": 215.738,
                "Flux": 1618.032,
                "Online": 125,
                "Request": 122,
                "Time": "2019-03-29 09:05:00"
                "Bandwidth": 226.96,
                "Flux": 1702.203,
                "Online": 131,
                "Request": 131,
                "Time": "2019-03-29 09:10:00"
            "IspName": "China Unicom",
            "ProvinceName": "Guangdong"
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"

    5. Developer Resources


    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.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    UnsupportedOperation Unsupported operation.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback