DescribeCdnDomainLogs

Last updated: 2020-02-10 16:19:38

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.

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: DescribeCdnDomainLogs
Version Yes String Common parameter. The value used for this API: 2018-06-06
Region No String Common parameter. 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 paged queries. Default value: 0 (the first page)
Limit No Integer Limit on paged 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.

3. Output Parameters

Parameter Name Type Description
DomainLogs Array of DomainLog Download link of the log package
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

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribeCdnDomainLogs
&StartTime=2019-09-04 00:00:00
&EndTime=2019-09-04 12:00:00
&Domain=www.test.com
&<common request parameters>

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"
      }
    ],
    "TotalCount": 300
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InternalError.DataSystemError Error with the data query. 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 This domain name does not exist under the account. Please check and try again.
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.
UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.