All Products
Search
Document Center

ApsaraVideo Live:SetLiveStreamsNotifyUrlConfig

Last Updated:May 13, 2025

Configures stream ingest callbacks under an ingest domain.

Operation description

  • You can call this operation to configure the callback URL and authentication information of an ingest domain.
  • If you configure callbacks for stream ingest status, you can receive callback notifications about successful or interrupted stream ingest in a timely manner. For more information, see Format of stream ingest callbacks.

QPS limit

You can call this operation up to 15 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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The ingest domain.

demo.aliyundoc.com
NotifyUrlstringNo

The URL to which the stream ingest callbacks are sent.

http://guide.aliyundoc.com/notify
ExceptionNotifyUrlstringNo

Exception event callback URL.

https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart
NotifyReqAuthstringNo

Specifies whether to enable callback authentication. Valid values:

  • yes: enables callback authentication. If you set this parameter to yes, you must also specify the NotifyAuthKey parameter.
  • no: disables callback authentication.
Note If you do not specify this parameter, the default value no is used.

For information about the authentication logic, see Authentication for stream ingest callbacks.

yes
NotifyAuthKeystringNo

The authentication key.

Note This parameter is required if you set the NotifyReqAuth parameter to yes.

Value requirements:

  • The key must be 16 to 64 characters in length.
  • The key can contain letters and digits.
123456

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

40A4F36D-A7CC-473A-88E7-154F92242566

Examples

Sample success responses

JSONformat

{
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamParameter invalid.Illegal input parameters
400ConfigAlreadyExistsConfig has already exist.-
500InternalErrorThe request processing has failed due to backend service exception.-

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

Change history

Change timeSummary of changesOperation
2025-04-01The Error code has changed. The request parameters of the API has changedView Change Details
2025-02-20The Error code has changed. The request parameters of the API has changedView Change Details