UpdateLiveRecordNotifyConfig

Updated at:
Copy as MD

Updates the domain-level recording callback configuration.

Operation description

When you update the domain-level recording callback configuration, you can modify the following settings:

  • The callback URL for recording events, including recording file generation event callbacks and recording task status callbacks. For more information, see Recording event callbacks.

  • The on-demand recording callback URL. For more information, see On-demand recording callback.

  • Whether recording task status callbacks are required.

QPS limit

The single-user QPS limit for this operation is 30 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:UpdateLiveRecordNotifyConfig

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None None

Request parameters

Parameter

Type

Required

Description

Example

DomainName

string

Yes

The streaming domain of the streamer.

example.com

NotifyUrl

string

Yes

The callback URL for recording events, including event callbacks and status callbacks.

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

  • To properly identify Chinese characters, spaces, and other special characters in the input, perform URL encoding.

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

OnDemandUrl

string

No

The on-demand recording callback URL.

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

  • To properly identify Chinese characters, spaces, and other special characters in the input, perform URL encoding.

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

NeedStatusNotify

boolean

No

Specifies whether recording task status callbacks are required. Valid values:

  • true: Recording task status callbacks are required.

  • false (default): Recording task status callbacks are not required.

false

NotifyReqAuth

boolean

No

Specifies whether to enable callback authentication. Valid values:

  • true: Enabled.

  • false: Disabled.

Note

Default value: false. If this parameter is set to true, the NotifyAuthKey parameter is required.

no

NotifyAuthKey

string

No

The callback authentication key. The key is 16 to 32 characters in length and can contain only letters and digits.

Note

This parameter is required when the NotifyReqAuth parameter is set to true.

testkeyyourkey12

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidNotifyUrl.Malformed Specified NotifyUrl is invalid. Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400 InvalidNotifyUrl.Unsafe Specified NotifyUrl is not safe. Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400 InvalidOnDemandUrl.Malformed Specified OnDemandUrl is invalid.
400 InvalidOnDemandUrl.Unsafe Specified OnDemandUrl is not safe.
400 InvalidDomain.NotFound Specified Domain is invalid.
400 Forbidden Ram Permission is forbidden.
404 InvalidConfig.NotFound Config does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.