DescribeLiveDomainTimeShiftData API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Queries time shifting usage data for each time interval.
Retrieves data for up to the last 90 days.
The data interval is fixed at 1 hour.
The maximum data timestamp span for a single query is 31 days.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API invoke is throttled, which may affect your business. Invoke this operation as needed.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain to query. Note When you specify DomainName, make sure that the specified domain is a live streaming domain and that the user calling this operation has permissions on the specified domain. You can specify a single domain or multiple domains. Separate multiple domains with commas (,). If this parameter is left empty, the merged data of all live streaming domains is returned by default.	example.com
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC. Note The minimum data granularity is 5 minutes. If you do not specify this parameter, data of the last 24 hours is returned by default.	2021-03-03T00:00:00Z
EndTime	string	No	The end time. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2021-03-03T02:00:00Z
Interval	string	No	The time granularity of the queried data. Unit: seconds. Valid values: If you do not specify this parameter or specify an unsupported value, the default value 300 is used.	300

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8AE1CB3A-6510-442E-A6B9-EF03D05B3E09
TimeShiftData	object
DataModule	array<object>	The time shifting usage data for each time interval.
	object	The time shifting usage data for each time interval.
Type	string	The time-shifting type, such as HLS_D1 and HLS_D7.	HLS_D7
TimeStamp	string	The start of the time slice.	2021-03-03T00:00:00Z
Size	string	The storage usage for time shifting. Unit: bytes.	1664165660

Examples

Success response

JSON format

{
  "RequestId": "8AE1CB3A-6510-442E-A6B9-EF03D05B3E09",
  "TimeShiftData": {
    "DataModule": [
      {
        "Type": "HLS_D7",
        "TimeStamp": "2021-03-03T00:00:00Z",
        "Size": "1664165660"
      }
    ]
  }
}

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	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.