DescribeLiveDomainLog - - Alibaba Cloud Documentation Center

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

Operation description

You can query the offline logs for only one domain name per API call.
The optional parameters StartTime and EndTime must be specified together. If you specify a start time and an end time, the operation queries logs within that time range.
If you do not specify StartTime and EndTime, the log data from the last 24 hours is retrieved by default.

QPS limit

This operation has a queries per second (QPS) limit of 100 calls/second per user. If you exceed this limit, API calls are throttled, which may affect your business. Call the operation at a reasonable rate.

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 ID of the region.	cn-shanghai
DomainName	string	Yes	The streaming domain or ingest domain. Note Ensure that the domain name is a live streaming domain and that you have the required permissions to operate on it. You can query only one domain name at a time.	example.com
PageSize	integer	No	The number of entries to return on each page. Valid values: An integer from 1 to 1,000. Default value: 300. Maximum value: 1,000.	20
PageNumber	integer	No	The page number. Note If you do not specify this parameter, data on the first page is returned.	1
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in Coordinated Universal Time (UTC).	2016-10-20T04:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC. The end time must be later than the start time. The time range cannot exceed 31 days.	2016-10-20T05:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
DomainName	string	The streaming domain or ingest domain.	example.com
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainLogDetails	object
DomainLogDetail	array<object>	The details of the domain logs.
	object
LogCount	integer	The total number of entries returned on the current page.	10
LogInfos	object
LogInfoDetail	array<object>	The details of the log information.
	object
EndTime	string	The end of the time range.	2016-10-20T05:00:00Z
LogSize	integer	The size of the log file.	10
StartTime	string	The beginning of the time range.	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 information about the page.
PageIndex	integer	The page number of the returned data.	1
PageSize	integer	The number of entries on each page.	20
Total	integer	The total number of log entries.	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.