DescribeLiveSnapshotConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the snapshot configurations of a streaming domain.

Operation description

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

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 number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.	10
Order	string	No	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.	asc

Response parameters

Parameter	Type	Description	Example
	object
PageNum	integer	The page number of the returned page.	2
RequestId	string	The ID of the request.	A3136B58-5876-4168-83CA-B562781981A0
Order	string	The rule used to sort entries.	asc
TotalPage	integer	The total number of returned pages.	10
PageSize	integer	The number of entries returned 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 name of the OSS object, which is to be overwritten each time a snapshot is captured.	{liveApp**}/{liveStream**}.jpg
TimeInterval	integer	The intervals at which the snapshots were captured. Unit: seconds.	10
AppName	string	The name of the application to which the streaming domain belongs.	liveApp****
CreateTime	string	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.	2016-05-20T01:33:38Z
OssBucket	string	The name of the Object Storage Service (OSS) bucket in which the snapshot is stored.	liveBucket****
DomainName	string	The main streaming domain.	example.com
Callback	string	The URL that is used to receive callback notifications about snapshot capturing.	https://learn.aliyundoc.com
SequenceOssObject	string	The name of the OSS object, which increments each time a snapshot is captured.	snapshot/{liveApp**}/{liveStream**}/{UnixTimestamp}.jpg
OssEndpoint	string	The endpoint of OSS.	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.