All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveDomainTimeShiftData

Last Updated:Nov 14, 2024

Queries the resource usage data of time shifting for one or more domain names.

Operation description

  • You can call this operation to query the time shifting usage data at each time interval.
  • You can query data in the last 90 days.
  • The time interval is 1 hour.
  • The maximum time range for a query is 31 days.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveDomainTimeShiftDataget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The main streaming domain to query.

  • You can query one or more domain names. If you specify multiple domain names, separate them with commas (,).
  • If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned.
example.com
StartTimestringNo

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note
  • The minimum data granularity is 5 minutes.

  • If you leave this parameter empty, data in the last 24 hours is queried.

2021-03-03T00:00:00Z
EndTimestringNo

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2021-03-03T02:00:00Z
IntervalstringNo

The time granularity of the query. Unit: seconds. Valid values:

  • 300
  • 3600
  • 86400

If you do not specify this parameter or specify an invalid value, the default value 300 is used.

300

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

8AE1CB3A-6510-442E-A6B9-EF03D05B3E09
TimeShiftDataarray<object>

The time shifting usage data that was collected for each time interval.

DataModuleobject

The time shifting usage data that was collected for each time interval.

Typestring

The type of time shifting. Examples: HLS_D1 and HLS_D7.

HLS_D7
TimeStampstring

The timestamp of the data returned.

2021-03-03T00:00:00Z
Sizestring

The storage used for time shifting. Unit: bytes.

1664165660

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.-
400InvalidEndTime.MalformedSpecified EndTime is malformed.-
400InvalidEndTime.MismatchSpecified 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.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The value specified for the StartTime parameter is invalid.

For a list of error codes, visit the Service error codes.