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
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | Yes | The ingest domain. | demo.aliyundoc.com |
NotifyUrl | string | No | The URL to which the stream ingest callbacks are sent. | http://guide.aliyundoc.com/notify |
ExceptionNotifyUrl | string | No | Exception event callback URL. | https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart |
NotifyReqAuth | string | No | Specifies whether to enable callback authentication. Valid values:
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 |
NotifyAuthKey | string | No | The authentication key. Note
This parameter is required if you set the NotifyReqAuth parameter to yes.
Value requirements:
| 123456 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParam | Parameter invalid. | Illegal input parameters |
400 | ConfigAlreadyExists | Config has already exist. | - |
500 | InternalError | The request processing has failed due to backend service exception. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2025-04-01 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2025-02-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |