Download Live Domain Logs with Time-Range Filters via API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Retrieves the download URLs of raw access logs for a specified domain name in ApsaraVideo Live.

Operation description

Each API call supports querying offline logs for only a single domain name.
The optional parameters StartTime and EndTime must be specified together. After you specify the start time and end time, logs within the specified time range are queried.
If you do not specify StartTime and EndTime, log data from the past 24 hours is returned by default.

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.

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

live:DescribeLiveDomainLog

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain or ingest domain. Note When you specify DomainName, make sure that the domain name is a live streaming domain name and that the user calling this operation has the required permissions on the specified domain name. Only a single domain name can be queried at a time.	example.com
PageSize	integer	No	The page size. Valid values: Any integer from 1 to 1000. Default value: 300. Maximum value: 1000.	20
PageNumber	integer	No	The page number. Valid values: [1, 9223372036854775807]. Note If you do not specify PageNumber, the first page of data is returned by default.	1
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-10-20T04:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The end time must be later than the start time. The interval between the start time and end time cannot exceed 31 days.	2016-10-20T05:00:00Z

Response elements

Element	Type	Description	Example
	object
DomainName	string	The streaming domain or ingest domain.	example.com
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainLogDetails	object
DomainLogDetail	array<object>	The data composed of DomainLogDetail entries.
	array<object>
LogCount	integer	The total number of entries returned on the current page.	10
LogInfos	object
LogInfoDetail	array<object>	The details of the log file.
	object
EndTime	string	The end time.	2016-10-20T05:00:00Z
LogSize	integer	The size of the log file.	10
StartTime	string	The start time.	2016-10-20T04:00:00Z
LogName	string	The name of the log file.	developer.aliyundoc.com_2016_10_20_040000_050000.gz
LogPath	string	The path of the log file.	learn.aliyundoc.com/developer.aliyundoc.com/2016_10_20/example.aliyundoc.com_2016_10_20_040000_050000.gz?Expires=1522659931&OSSAccessKeyId=LTAI****eo4ZEuA&Signature=C01p%2BtA%****KP9Sru2Oxwy7Do0%3D
PageInfos	object	The page information.
PageIndex	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
Total	integer	The total number of entries returned.	20

Examples

Success response

JSON format

{
  "DomainName": "example.com",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainLogDetails": {
    "DomainLogDetail": [
      {
        "LogCount": 10,
        "LogInfos": {
          "LogInfoDetail": [
            {
              "EndTime": "2016-10-20T05:00:00Z",
              "LogSize": 10,
              "StartTime": "2016-10-20T04:00:00Z",
              "LogName": "developer.aliyundoc.com_2016_10_20_040000_050000.gz",
              "LogPath": "learn.aliyundoc.com/developer.aliyundoc.com/2016_10_20/example.aliyundoc.com_2016_10_20_040000_050000.gz?Expires=1522659931&OSSAccessKeyId=LTAI******eo4ZEuA&Signature=C01p%2BtA%******KP9Sru2Oxwy7Do0%3D"
            }
          ]
        },
        "PageInfos": {
          "PageIndex": 1,
          "PageSize": 20,
          "Total": 20
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.