All Products
Search
Document Center

ApsaraVideo Live:AddLiveRecordNotifyConfig

Last Updated:Dec 24, 2024

Configures recording callbacks for a domain name.

Operation description

Before you call this operation to configure recording callbacks for a domain name, you can query whether the domain name already has recording callbacks configured. For more information, see DescribeLiveRecordNotifyConfig .

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.

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:AddLiveRecordNotifyConfigcreate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com
NotifyUrlstringYes

The callback URL that is used to receive notifications about recording events and status.

Note The URL must start with http:// or https://. For more information, see Callbacks for live stream recording.
http://demo.aliyundoc.com/examplecallback.action
NeedStatusNotifybooleanNo

Specifies whether to enable callbacks for recording status. Valid values:

  • true: enables callbacks for recording status. If you set this parameter to true, an example of recording status callback is returned.
  • false (default): disables callbacks for recording status.
false
OnDemandUrlstringNo

The callback URL for on-demand recordings.

Note The URL must start with http:// or https://. For more information, see On-demand recording.
http://learn.aliyundoc.com/ondemandcallback.action

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidNotifyUrl.MalformedSpecified NotifyUrl is invalid.Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400InvalidNotifyUrl.UnsafeSpecified NotifyUrl is not safe.Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400ConfigAlreadyExistsConfig has already exist.-
400InvalidOnDemandUrl.MalformedSpecified OnDemandUrl is invalid.-
400InvalidOnDemandUrl.UnsafeSpecified OnDemandUrl is not safe.-

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

Change history

Change timeSummary of changesOperation
No change history