All Products
Search

This Product

    ApsaraVideo Live:AddLiveAppSnapshotConfig

    Document Center

    ApsaraVideo Live:AddLiveAppSnapshotConfig

    Last Updated:Nov 14, 2024

    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

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:AddLiveAppSnapshotConfigcreate
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The main streaming domain.

    		example.com
    AppNamestringYes

    The name of the application to which the live stream belongs.

    		liveApp****
    TimeIntervalintegerYes

    The intervals at which the snapshots are captured. Unit: seconds. Valid values: 5 to 3600.

    		5
    OssEndpointstringYes

    The endpoint of OSS.

    		cn-oss-****.aliyuncs.com
    OssBucketstringYes

    The name of the OSS bucket in which the snapshots are stored.

    		liveBucket****
    OverwriteOssObjectstringNo

    The name of the OSS object, which is to be overwritten each time when a snapshot is captured.

    • The name must be less than 256 bytes in length.
    • Only JPG files are supported.
    • The name can contain variables, such as {AppName} and {StreamName}.
    		{AppName}/{StreamName}.jpg
    SequenceOssObjectstringNo

    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.

    • The name must be less than 256 bytes in length.
    • Only JPG files are supported.
    • The name can contain variables, such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. You must specify one of {UnixTimestamp} and {Sequence}.
    		snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
    CallbackstringNo

    The URL that is used to receive callback notifications about snapshot capturing.

    		https://learn.aliyundoc.com

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidOverwriteOssObjectOrSequenceOssObject.MalformedSpecified paramters OverwriteOssObject or SequenceOssObject should have one.You can specify only one of the OverwriteOssObject and SequenceOssObject parameters.
    400InvalidOssBucket.MalformedSpecified parameter OssBucket is not valid.-
    400InvalidOssEndpoint.MalformedSpecified parameter OssEndpoint is not valid.-
    400InvalidOverwriteOssObject.MalformedSpecified parameter OverwriteOssObject is not valid.-
    400InvalidSequenceOssObject.MalformedSpecified parameter SequenceOssObject is not valid.Invalid value of SequenceOssObject. Check whether the SequenceOssObject parameter that you specified is correct.
    400InvalidOssBucket.NotFoundThe parameter OssBucket does not exist.-
    400ConfigAlreadyExistsConfig has already exist.-

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

    Change history

    Change timeSummary of changesOperation
    No change history