Query CDN access logs for a domain using DescribeVodDomainLog - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the download URLs of raw CDN access logs for a specified domain name.

Operation description

Currently, the only supported service region is China (Shanghai).
For details about log formats and latency, refer to Log Management.
If you do not specify StartTime and EndTime, log data from the past 24 hours is returned by default.
StartTime and EndTime must be specified together to query logs within the specified time range.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodDomainLog

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name for ApsaraVideo VOD. Note Only a single domain name is supported.	example.com
PageSize	integer	No	The number of entries per page. Default value: 300 Maximum value: 1000	300
PageNumber	integer	No	The page number. Default value: 1.	1
StartTime	string	No	The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format (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 interval between the start time and end time cannot exceed one year. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2016-10-20T05:00:00Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	077D0284-F041-4A41-4D3C-B48377FD****
DomainLogDetails	object
DomainLogDetail	array<object>	The detailed CDN log data.
	array<object>	The CDN log details.
LogCount	integer	The total number of entries returned on the current page.	2
DomainName	string	The domain name.	example.com
LogInfos	object
LogInfoDetail	array<object>	The queried CDN logs.
	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	integer	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	integer	The page number.	1
PageSize	integer	The number of entries per page.	300
Total	integer	The total number of entries returned.	2

Examples

Success response

JSON format

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

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The start time is in an invalid format.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidTime.ValueNotSupported	StartTime or EndTime is miss match.
400	InvalidParameter	The specified parameter \ is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.