tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCdnLogs

Last updated: 2024-03-27 16:10:00

    1. API Description

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

    This API is used to query the download links of CDN access logs of a VOD domain name.
    1. Only download links of CDN logs for the last 30 days can be queried.
    2. By default, CDN generates a log file every hour. If there is no CDN access for a certain hour, no log file will be generated for the hour.
    3. A CDN log download link is valid for 24 hours.

    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: DescribeCdnLogs.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    DomainName Yes String Domain name.
    StartTime Yes String Start time for log acquisition in ISO date format.
    EndTime Yes String End time in ISO date format, which must be after the start time.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Limit No Integer Maximum return results of pulling paginated queries. Default value: 100; maximum value: 1000
    Offset No Integer Page number offset from the beginning of paginated queries. Default value: 0

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of log download links
    Note: this field may return null, indicating that no valid value is obtained.
    OverseaCdnLogs Array of CdnLogInfo Log download list for CDN nodes outside Mainland China. If global acceleration is not enabled for the domain name, ignore this parameter.
    Note: this field may return null, indicating that no valid values can be obtained.
    DomesticCdnLogs Array of CdnLogInfo Log download list for CDN nodes in Mainland China.
    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

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeCdnLogs
&DomainName=test.vod2.myqcloud.com
&StartTime=2021-03-01T00:00:00+08:00
&EndTime=2021-03-02T00:00:00+08:00
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 202,
        "DomesticCdnLogs": [
            {
                "Date": "2021-03-01",
                "Name": "2018120213-test.vod2.myqcloud.com",
                "Url": "http: //test.log.cdn/2018120213-test.vod2.myqcloud.com.tar.gz",
                "StartTime": "2021-03-01T15:00:00+08:00",
                "EndTime": "2021-03-01T15:59:59+08:00"
            }
        ],
        "OverseaCdnLogs": [],
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

    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.
    FailedOperation.NetWorkError Network error.
    InternalError Internal error.
    InvalidParameterValue.DomainName Invalid parameter: the domain name does not exist.
    InvalidParameterValue.EndTime Incorrect parameter value: invalid EndTime.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy