DescribeLivePushProxyLog - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call the DescribeLivePushProxyLog operation to obtain the download URLs for offline logs of proxied live streams.

Operation description

The time granularity for a query is 1 hour.
The maximum time range to query is the last 31 days.
If you do not specify StartTime and EndTime, data from the last 24 hours is returned. If you specify both parameters, data in the specified time range is returned.

QPS limit

The queries per second (QPS) limit for a single user is 100 calls/second. If the limit is exceeded, API calls are throttled. This may affect your business. Plan your calls accordingly.

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:DescribeLivePushProxyLog

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest domain. You cannot query multiple domain names in a single request.	example.com
PageSize	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 300.	300
PageNumber	integer	No	The page number. Default value: 1.	2
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.	2023-09-20T08:00:00Z
EndTime	string	No	The end 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.	2023-09-20T09:00:00Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
DomainLogDetails	object
DomainLogDetail	array<object>	An array of `DomainLogDetail` objects.
	array<object>	An array of `DomainLogDetail` objects.
LogCount	integer	The total number of entries returned on the current page.	10
LogInfos	object
LogInfoDetail	array<object>	An array of `LogInfoDetail` objects.
	object	An array of `LogInfoDetail` objects.
EndTime	string	The end time. The value is a UNIX timestamp.	1695189600
LogName	string	The log name.	example.com _2023_09_20_160000_170000.****.gz
LogPath	string	The log path.	**.aliyuncs.com/push_proxy//example.com/2023_09_20/1600/example.com _2023_09_20_160000_170000.**.gz
LogSize	integer	The log size.	512
StartTime	string	The start time. The value is a UNIX timestamp.	1695193200
PageInfos	object	Paging information.
PageIndex	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
Total	integer	The total number of entries.	20
DomainName	string	The ingest domain.	example.com
RequestId	string	The request ID.	CF60DB6A-7FD6-426E-9288-122CC1A52FA7

Examples

Success response

JSON format

{
  "DomainLogDetails": {
    "DomainLogDetail": [
      {
        "LogCount": 10,
        "LogInfos": {
          "LogInfoDetail": [
            {
              "EndTime": "1695189600",
              "LogName": "example.com\n_2023_09_20_160000_170000.****.gz",
              "LogPath": "****.aliyuncs.com/push_proxy/****/example.com/2023_09_20/1600/example.com\n_2023_09_20_160000_170000.****.gz",
              "LogSize": 512,
              "StartTime": "1695193200"
            }
          ]
        },
        "PageInfos": {
          "PageIndex": 1,
          "PageSize": 20,
          "Total": 20
        }
      }
    ]
  },
  "DomainName": "example.com",
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	Invalid Parameter	The specified Invalid Parameter
400	Internal Error	Internal Error contact admin

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.