Configures snapshot settings for a streaming domain.
Operation description
The Object Storage Service (OSS) bucket must reside in the same region as the live center that you select when you add the domain. Cross-region snapshot capture is not supported.
QPS limit
A single user can perform a maximum of 30 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
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 Resourcesis 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:AddLiveAppSnapshotConfig | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
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 | Yes | The intervals at which the snapshots are captured. Unit: seconds. Valid values: 5 to 3600. | 5 |
| OssEndpoint | string | Yes | The endpoint of OSS. | cn-oss-****.aliyuncs.com |
| OssBucket | string | Yes | The name of the OSS bucket in which the snapshots are stored. | liveBucket**** |
| OverwriteOssObject | string | No | The name of the OSS object, which is to be overwritten each time when a snapshot is captured.
| {AppName}/{StreamName}.jpg |
| SequenceOssObject | string | No | The name of the OSS object, which increments each time when a snapshot is captured. You can call the DescribeLiveStreamSnapshotInfo operation to query OSS objects of a specified period.
| snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg |
| Callback | string | No | The URL that is used to receive callback notifications about snapshot capturing. | https://learn.aliyundoc.com |
Response parameters
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 | InvalidOssBucket.Malformed | Specified parameter OssBucket is not valid. | - |
| 400 | InvalidOssEndpoint.Malformed | Specified parameter OssEndpoint is not valid. | - |
| 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 | InvalidOssBucket.NotFound | The parameter OssBucket does not exist. | - |
| 400 | ConfigAlreadyExists | Config has already exist. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|