DescribeLiveShiftConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the time shifting configurations under a domain name.

Operation description

This operation is applicable to the streaming domains.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveShiftConfigs	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain.	example.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	B49E6DDA-F413-422B-B58E-2FA23F286726
Content	array<object>	The time shifting configurations.
Config	object
IgnoreTranscode	boolean	Whether to ignore time shift generation for the transcode stream. true: Ignore time shifting generation. false: Generate time shifting. The default value is true.	true
AppName	string	The application for which you configure time shifting.	liveApp****
StreamName	string	The name of the live stream for which you configure time shifting.	liveStream****
DomainName	string	The domain name for which you configure time shifting.	example.com
Vision	integer	The number of days for which the time shifting configurations are retained.	7

Special error codes

Error code	Error message	HTTP status code	Description
InvalidParam	param error	400	The error message returned because one or more specified parameters are invalid.
InvalidDataNotFound	data not found	404	The error message returned because user data cannot be found.

Examples

Sample success responses

JSONformat

{
  "RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726",
  "Content": {
    "Config": [
      {
        "IgnoreTranscode": true,
        "AppName": "liveApp****",
        "StreamName": "liveStream****",
        "DomainName": "example.com",
        "Vision": 7
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParam	%s
404	InvalidDataNotFound	%s
409	InvalidStreamNum	%s

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