DescribeLiveSnapshotConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the snapshot configurations of a streaming domain.

Operation description

Obtain the main streaming domain, and then call this operation to query the snapshot configurations.

QPS limit

You can call this operation up to 100 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.

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:DescribeLiveSnapshotConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	No	The name of the application to which the live stream belongs.	liveApp****
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 5 to 30. Default value: 10.	10
Order	string	No	The sort order. Valid values: asc (default): ascending order desc: descending order	asc

Response parameters

Parameter	Type	Description	Example
	object
PageNum	integer	The page number.	2
RequestId	string	The request ID.	A3136B58-5876-4168-83CA-B562781981A0
Order	string	The sort order.	asc
TotalPage	integer	The total number of pages.	10
PageSize	integer	The number of entries per page.	11
TotalNum	integer	The total number of entries that meet the specified conditions.	6
LiveStreamSnapshotConfigList	array<object>	The snapshot configurations.
LiveStreamSnapshotConfig	object
OverwriteOssObject	string	The naming format of snapshots that are stored in the overwrite mode, which means that a new snapshot overwrites the previous snapshot.	{liveApp**}/{liveStream**}.jpg
TimeInterval	integer	The interval at which snapshots are captured. Unit: seconds.	10
AppName	string	The name of the application to which the live stream belongs.	liveApp****
CreateTime	string	The time when the configuration was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-05-20T01:33:38Z
OssBucket	string	The name of the Object Storage Service (OSS) bucket.	liveBucket****
DomainName	string	The main streaming domain.	example.com
Callback	string	The callback URL that is used to receive notifications about snapshot capture.	https://learn.aliyundoc.com
SequenceOssObject	string	The naming format of snapshots that are stored in sequence, which means that a new snapshot does not overwrite the previous snapshot.	snapshot/{liveApp**}/{liveStream**}/{UnixTimestamp}.jpg
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com

Examples

Sample success responses

JSONformat

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

Error codes

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