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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveSnapshotConfig

get

*All Resource

*

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 elements

Element	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	object
LiveStreamSnapshotConfig	array<object>	The snapshot configurations.
	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.