tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCdnDomainLogs

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

    1. API Description

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

    This API is used to query the download link of an access log. You can use this API for access logs in the last 30 days either within or outside Mainland China.

    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: DescribeCdnDomainLogs.
    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.
    Domain Yes String Specifies a domain name for the query
    StartTime Yes Timestamp Starting time, such as 2019-09-04 00:00:00
    EndTime Yes Timestamp End time, such as 2019-09-04 12:00:00
    Offset No Integer Offset for paginated queries. Default value: 0
    Limit No Integer Limit on paginated queries. Default value: 100. Maximum value: 1,000
    Area No String Specifies a region for the query.
    mainland: specifies to return the download link of logs on acceleration within Mainland China;
    overseas: specifies to return the download link of logs on acceleration outside Mainland China;
    global: specifies to return a download link of logs on acceleration within Mainland China and a link of logs on acceleration outside Mainland China.
    Default value: mainland.
    LogType No String Specifies the type of logs to download (only access logs supported).
    access: Access logs.

    3. Output Parameters

    Parameter Name Type Description
    DomainLogs Array of DomainLog Download link of the log package.
    You can open the link to download a .gz log package that contains all log files without extension.
    TotalCount Integer Total number of entries obtained
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    This example shows you how to query logs for a specified period.

    Input Example

    POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCdnDomainLogs
<Common request parameters>

{
    "Domain": "www.test.com",
    "EndTime": "2019-09-04 12:00:00",
    "StartTime": "2019-09-04 00:00:00"
}

    Output Example

    {
    "Response": {
        "RequestId": "123",
        "DomainLogs": [
            {
                "Area": "mainland",
                "StartTime": "2019-09-04 23:00:00",
                "EndTime": "2019-09-04 23:59:59",
                "LogPath": "http://www.test.qcloud.com/20190904/23/201909042300-www.test.com.gz?st=hGzJr0QFpo3jYM2uj7kkjA&e=3135214538",
                "LogName": "2019090423",
                "FileSize": 9999
            }
        ],
        "TotalCount": 300
    }
}

    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
    AuthFailure.InvalidAuthorization Authentication error. Please check and try again.
    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.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.CdnHostInvalidStatus Invalid domain name status.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.CdnStatInvalidDate Invalid date. Please see the sample date in the documentation.
    ResourceNotFound.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    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.CdnUserAuthFail Fail to authenticate the CDN user.
    UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
    UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy