All Products
Search
Document Center

ApsaraVideo Live:UpdateLiveRecordNotifyConfig

Last Updated:Sep 27, 2024

Modifies the recording callback configuration of a streaming domain.

Operation description

Usage notes

You can call this operation to modify the following settings:

  • The callback URL that is used to receive notifications about recording events and status. For more information, see Recording event callbacks.
  • The callback URL for on-demand recordings. For more information, see On-demand recording callbacks.
  • The setting that specifies whether to enable callbacks for recording status.

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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:UpdateLiveRecordNotifyConfigupdate
  • 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://.

  • You must use URLEncoder for encoding. This way, the system can identify Chinese characters, spaces, and special characters.

http://learn.aliyundoc.com/examplecallback.action
OnDemandUrlstringNo

The callback URL for on-demand recordings.

Note
  • The URL must start with http:// or https://.

  • You must use URLEncoder for encoding so that the system can identify Chinese characters, spaces, and special characters.

http://guide.aliyundoc.com/ondemandcallback.action
NeedStatusNotifybooleanNo

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

  • true
  • false (default)
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

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.
400InvalidOnDemandUrl.MalformedSpecified OnDemandUrl is invalid.-
400InvalidOnDemandUrl.UnsafeSpecified OnDemandUrl is not safe.-
400InvalidDomain.NotFoundSpecified Domain is invalid.-
400ForbiddenRam Permission is forbidden.-
404InvalidConfig.NotFoundConfig does not exist.-

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

Change history

Change timeSummary of changesOperation
No change history