UpdateLiveAppSnapshotConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Modifies a snapshot configuration of a streaming domain. The captured snapshots are stored in Object Storage Service (OSS). The modification takes effect after you restart stream ingest.

Operation description

You can call this operation to modify a snapshot configuration of a streaming domain. The captured snapshots are stored in OSS. The modification takes effect after you restart stream ingest.

QPS limit

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs.	liveApp****
TimeInterval	integer	No	The interval at which snapshots are captured. Valid values: 5 to 3600. Unit: seconds.	5
OssEndpoint	string	No	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com
OssBucket	string	No	The name of the OSS bucket.	liveBucket****
OverwriteOssObject	string	No	The naming format of snapshots that are stored in the overwrite mode, which means that a new snapshot overwrites the previous snapshot. The name must be less than 256 bytes in length. Only JPG images are supported. The name can contain variables such as {AppName} and {StreamName}. A value of hyphen (-) indicates that this parameter is deleted.	{liveApp**}/{liveStream**}.jpg
SequenceOssObject	string	No	The naming format of snapshots that are stored in sequence, which means that a new snapshot does not overwrite the previous snapshot. You can call the DescribeLiveStreamSnapshotInfo operation to query the snapshots that were captured within a specific time period. The name must be less than 256 bytes in length. Only JPG images are supported. The name can contain variables such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. The name must contain at least one of the {UnixTimestamp} and {Sequence} variables. A value of hyphen (-) indicates that this parameter is deleted.	snapshot/{liveApp**}/{liveStream}/{UnixTimestamp**}.jpg
Callback	string	No	The callback URL that is used to receive notifications about snapshot capture.	https://learn.aliyundoc.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOverwriteOssObjectOrSequenceOssObject.Malformed	Specified paramters OverwriteOssObject or SequenceOssObject should have one.	You can specify only one of the OverwriteOssObject and SequenceOssObject parameters.
400	InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is not valid.	-
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.	-
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.	-
400	InvalidOverwriteOssObject.Malformed	Specified parameter OverwriteOssObject is not valid.	-
400	InvalidSequenceOssObject.Malformed	Specified parameter SequenceOssObject is not valid.	Invalid value of SequenceOssObject. Check whether the SequenceOssObject parameter that you specified is correct.
400	InvalidConfig.NotFound	The speicified config does not exist.	-

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

Change history

Change time	Summary of changes	Operation

No change history