Queries the information about the raw access logs for a specific domain name, including the log path.

Usage note

  • This operation is available only in the China (Shanghai) region.
  • For more information about the log format and latency, see Download logs.
  • If you specify neither the StartTime parameter nor the EndTime parameter, the log data in the last 24 hours is queried.
  • You can specify both the StartTime and EndTime parameters to query the log data that is generated in the specified duration.

QPS limit

A single user can perform a maximum of 100 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVodDomainLog

The operation that you want to perform. Set the value to DescribeVodDomainLog.

DomainName String Yes example.com

The domain name.

Note You can specify only one domain name in each query.
PageSize Long No 300

The number of entries to return on each page.

  • Default value: 300.
  • Maximum value: 1000.
PageNumber Long No 1

The number of the page to return. Default value: 1.

StartTime String No 2016-10-20T04:00:00Z

The start of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EndTime String No 2016-10-20T05:00:00Z

The end of the time range to query. The end time must be later than the start time. The time range that is specified by the StartTime and EndTime parameters cannot exceed one year. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters

Parameter Type Example Description
DomainLogDetails Array of DomainLogDetail

The detailed data of Alibaba Cloud CDN logs.

DomainLogDetail
DomainName String example.com

The domain name.

LogCount Long 2

The total number of entries returned on the current page.

LogInfos Array of LogInfoDetail

The detailed information about Alibaba Cloud CDN logs.

LogInfoDetail
EndTime String 2018-05-31T05:00:00Z

The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

LogName String example.com_2018_03_25_180000_19****.gz

The name of the log file.

LogPath String example.aliyundoc.com/example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&OSSAccessKeyId=****&Signature=****

The path of the log file.

LogSize Long 2645401

The size of the log file.

StartTime String 2018-05-31T04:00:00Z

The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

PageInfos Struct

The pagination settings of Alibaba Cloud CDN logs.

PageNumber Long 1

The page number of the returned page.

PageSize Long 300

The number of entries returned per page.

Total Long 2

The total number of entries returned.

RequestId String 077D0284-F041-4A41-4D3C-B48377FD****

The ID of the request.

Examples

Sample requests

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=DescribeVodDomainLog
&DomainName=example.com
&PageSize=300
&PageNumber=1
&StartTime=2016-10-20T04:00:00Z
&EndTime=2016-10-20T05:00:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVodDomainLogResponse>
    <RequestId>077D0284-F041-4A41-4D3C-B48377FD****</RequestId>
    <DomainLogDetails>
        <LogCount>2</LogCount>
        <DomainName>example.com</DomainName>
        <LogInfos>
            <EndTime>2018-05-31T05:00:00Z</EndTime>
            <LogSize>2645401</LogSize>
            <StartTime>2018-05-31T04:00:00Z</StartTime>
            <LogName>example.com_2018_03_25_180000_19****.gz</LogName>
            <LogPath>example.aliyundoc.com/example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&amp;OSSAccessKeyId=****&amp;Signature=****</LogPath>
        </LogInfos>
        <PageInfos>
            <PageNumber>1</PageNumber>
            <PageSize>300</PageSize>
            <Total>2</Total>
        </PageInfos>
    </DomainLogDetails>
</DescribeVodDomainLogResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "077D0284-F041-4A41-4D3C-B48377FD****",
  "DomainLogDetails" : [ {
    "LogCount" : 2,
    "DomainName" : "example.com",
    "LogInfos" : [ {
      "EndTime" : "2018-05-31T05:00:00Z",
      "LogSize" : 2645401,
      "StartTime" : "2018-05-31T04:00:00Z",
      "LogName" : "example.com_2018_03_25_180000_19****.gz",
      "LogPath" : "example.aliyundoc.com/example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&OSSAccessKeyId=****&Signature=****"
    } ],
    "PageInfos" : {
      "PageNumber" : 1,
      "PageSize" : 300,
      "Total" : 2
    }
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.