Queries the snapshot configurations of a streaming domain.

Usage note

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 100 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 DescribeLiveSnapshotConfig

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

DomainName String Yes example.com

The main streaming domain.
AppName String No liveApp****

The name of the application to which the live stream belongs.
PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.

Order String No asc

The rule used to sort entries. Valid values:

  • asc: The entries are sorted in ascending order. This is the default value.
  • desc: The entries are sorted in descending order.

Response parameters

Parameter Type Example Description
RequestId String A3136B58-5876-4168-83CA-B562781981A0

The ID of the request.
LiveStreamSnapshotConfigList Array of LiveStreamSnapshotConfig

The snapshot configurations.
LiveStreamSnapshotConfig
DomainName String demo.aliyundoc.com

The main streaming domain.
AppName String liveApp****

The name of the application to which the streaming domain belongs.
TimeInterval Integer 10

The intervals at which the snapshots were captured. Unit: seconds.
CreateTime String 2016-05-20T01:33:38Z

The time when the snapshot was captured. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Callback String https://learn.aliyundoc.com

The URL that is used to receive callback notifications about snapshot capturing.
OssBucket String liveBucket****

The name of the Object Storage Service (OSS) bucket in which the snapshot is stored.
OssEndpoint String oss-cn-shanghai.aliyuncs.com

The endpoint of OSS.
OverwriteOssObject String {AppName}/{StreamName}.jpg

The name of the OSS object, which is to be overwritten each time a snapshot is captured.
SequenceOssObject String snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg

The name of the OSS object, which increments each time a snapshot is captured.
PageNum Integer 2

The page number of the returned page.
PageSize Integer 11

The number of entries returned per page.
Order String asc

The rule used to sort entries.
TotalPage Integer 10

The total number of returned pages.
TotalNum Integer 6

The total number of entries that meet the specified conditions.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeLiveSnapshotConfigResponse>
  <Order>asc</Order>
  <TotalNum>6</TotalNum>
  <TotalPage>10</TotalPage>
  <PageSize>11</PageSize>
  <PageNum>2</PageNum>
  <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>
  <LiveStreamSnapshotConfigList>
        <LiveStreamSnapshotConfig>
              <OverwriteOssObject>{AppName}/{StreamName}.jpg</OverwriteOssObject>
              <SequenceOssObject>snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg</SequenceOssObject>
              <Callback>https://learn.aliyundoc.com</Callback>
              <OssEndpoint>oss-cn-shanghai.aliyuncs.com</OssEndpoint>
              <TimeInterval>10</TimeInterval>
              <DomainName>example.com</DomainName>
              <CreateTime>2016-05-20T01:33:38Z</CreateTime>
              <OssBucket>liveBucket****</OssBucket>
              <AppName>liveApp****</AppName>
        </LiveStreamSnapshotConfig>
  </LiveStreamSnapshotConfigList>
</DescribeLiveSnapshotConfigResponse>

JSON format 

{
    "Order": "asc",
    "TotalNum": "6",
    "TotalPage": "10",
    "PageSize": "11",
    "PageNum": "2",
    "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
    "LiveStreamSnapshotConfigList": {
        "LiveStreamSnapshotConfig": [{
            "OverwriteOssObject": "{AppName}/{StreamName}.jpg",
            "SequenceOssObject": "snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg",
            "Callback": "https://learn.aliyundoc.com",
            "OssEndpoint": "oss-cn-shanghai.aliyuncs.com",
            "TimeInterval": "10",
            "DomainName": "example.com",
            "CreateTime": "2016-05-20T01:33:38Z",
            "OssBucket": "liveBucket****",
            "AppName": "liveApp****"
        }]
    }
}

Error codes

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