DescribeCdnLogs

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-04-07 20:00:44

Download PDF

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 parameter. The value used for this API: DescribeCdnLogs.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-17.
Region	No	String	Common parameter. This parameter is not required for this API.
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.
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
SubAppId	No	Integer	Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying CDN log download link

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

Tencent Cloud CLI 3.0

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.

Recent Pages