DescribeVodDomainLog - ApsaraVideo VOD - Alibaba Cloud Documentation Center

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

Operation description

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 time range.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:DescribeVodDomainLog	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name for CDN. Note You can specify only one domain name in each query.	example.com
PageSize	long	No	The number of entries per page. Default value: 300. Valid values: 1 to 1000.	300
PageNumber	long	No	The page number. Default value: 1.	1
StartTime	string	No	The beginning 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
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. The maximum time range that can be specified is 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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	077D0284-F041-4A41-4D3C-B48377FD****
DomainLogDetails	array<object>	The details of CDN logs.
DomainLogDetail	object	The detailed data of Alibaba Cloud CDN logs.
LogCount	long	The total number of entries returned on the current page.	2
DomainName	string	The domain name.	example.com
LogInfos	array<object>	The queried CDN logs.
LogInfoDetail	object	The detailed information about Alibaba Cloud CDN logs.
EndTime	string	The end of the time range during 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
LogSize	long	The size of the log file.	2645401
StartTime	string	The beginning of the time range during 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
LogName	string	The name of the log file.	example.com_2018_03_25_180000_19****.gz
LogPath	string	The path of the log file.	example.com/2018_03_25/example.com_2018_03_25_180000_19**.gz?Expires=1522659931&OSSAccessKeyId=&Signature=**
PageInfos	object	The pagination information.
PageNumber	long	The page number.	1
PageSize	long	The number of entries per page.	300
Total	long	The total number of entries returned.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "077D0284-F041-4A41-4D3C-B48377FD****",
  "DomainLogDetails": {
    "DomainLogDetail": [
      {
        "LogCount": 2,
        "DomainName": "example.com",
        "LogInfos": {
          "LogInfoDetail": [
            {
              "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 Service error codes.