All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainLog

Last Updated:Nov 09, 2022

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

Operation Description

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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:DescribeVodDomainLogWrite
  • VOD
    acs:vod:*:{#accountId}:*
    without
without
vod:DescribeVodDomainLogRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The domain name.

NoteYou can specify only one domain name in each query.
example.com
PageSizelongNo

The number of entries to return on each page.

  • Default value: 300.
  • Maximum value: 1000.
300
PageNumberlongNo

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

1
StartTimestringNo

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.

2016-10-20T04:00:00Z
EndTimestringNo

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.

2016-10-20T05:00:00Z

Response parameters

ParameterTypeDescriptionExample
object

The returned datas.

RequestIdstring

The ID of the request.

077D0284-F041-4A41-4D3C-B48377FD****
DomainLogDetailsarray

The detailed data of Alibaba Cloud CDN logs.

object

The detailed data of Alibaba Cloud CDN logs.

LogCountlong

The total number of entries returned on the current page.

2
DomainNamestring

The domain name.

example.com
LogInfosarray

The detailed information about Alibaba Cloud CDN logs.

object

The detailed information about Alibaba Cloud CDN logs.

EndTimestring

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.

2018-05-31T05:00:00Z
LogSizelong

The size of the log file.

2645401
StartTimestring

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.

2018-05-31T04:00:00Z
LogNamestring

The name of the log file.

example.com_2018_03_25_180000_19****.gz
LogPathstring

The path of the log file.

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

The pagination settings of Alibaba Cloud CDN logs.

PageNumberlong

The page number of the returned page.

1
PageSizelong

The number of entries returned per page.

300
Totallong

The total number of entries returned.

2

Example

Normal return example

JSONFormat

{
  "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.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.