Queries the time shifting configurations under a domain name.

Usage note

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveShiftConfigs

The operation that you want to perform. Set the value to DescribeLiveShiftConfigs.

DomainName String Yes example.com

The streaming domain.

RegionId String No cn-shanghai

The ID of the region where the streaming domain resides.

Response parameters

Parameter Type Example Description
Content Array of Config

The time shifting configurations.

Config
AppName String liveApp****

The application for which you configure time shifting.

DomainName String example.com

The domain name for which you configure time shifting.

IgnoreTranscode Boolean true Whether to ignore time shift generation for the transcode stream.
  • true: Ignore time shifting generation.
  • false: Generate time shifting.

The default value is true.
StreamName String liveStream****

The name of the live stream for which you configure time shifting.

Vision Integer 7

The number of days for which the time shifting configurations are retained.

RequestId String B49E6DDA-F413-422B-B58E-2FA23F286726

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveShiftConfigs
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveShiftConfigsResponse>
  <RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>
  <Content>
        <Config>
              <IgnoreTranscode>true</IgnoreTranscode>
              <StreamName>liveStream****</StreamName>
              <DomainName>example.com</DomainName>
              <Vision>7</Vision>
              <AppName>liveApp****</AppName>
        </Config>
  </Content>
</DescribeLiveShiftConfigsResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.

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.