All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveShiftConfigs

更新時間:Jun 28, 2024

Queries the time shifting configurations of a domain name.

Usage notes

Obtain the streaming domain, and then call this operation to query the time shifting configurations.

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. For more information, see QPS limits.

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.

Response parameters

Parameter

Type

Example

Description

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

The request ID.

Content Array of Config

The configurations.

Config
AppName String liveApp****

The application for which time shifting is configured.

Vision Integer 7

The number of days for which data is retained.

DomainName String example.com

The domain name for which time shifting is configured.

StreamName String liveStream****

The name of the live stream for which time shifting is configured.

IgnoreTranscode Boolean true

Indicates whether time shifting is disabled for the transcoded stream. Valid values:

  • true: Time shifting is disabled for the transcoded stream.
  • false: Time shifting is enabled for the transcoded stream.

Default value: true.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.

Special error codes

Error code

Error message

HTTP status code

Description

InvalidParam

param error

400

One or more specified parameters are invalid.

InvalidDataNotFound

data not found

404

The user data cannot be found.