Documentation
Server APIs v2
Streaming control
Clear tasks of stream forwarding to CDN

Clear tasks of stream forwarding to CDN

Last updated：2025-01-24 17:55

1 Description

Clears all the scheduled tasks of stream forwarding to CDN for the specified Stream ID. This only affects the tasks that have not yet started.

2 Request method and endpoint

Request method: GET
Request endpoint: https://rtc-api.zego.im/?Action=ClearCDNTransferRule
Transmission protocol: HTTPS
Rate limit: 10 requests/second (Testing environment: 5 requests/second)

3 Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Server APIs public request parameters.

Parameter	Type	Required	Description
StreamId	String	Yes	Stream ID.
Sequence	String	Yes	Request sequence number. For the same StreamId, within 10 consecutive seconds, the request sequence number must be strictly increasing to avoid operation disorder due to inconsistent request timing on the server side. If there is no concurrent scenario, it is recommended to use a timestamp (in milliseconds).

4 Sample request

https://rtc-api.zego.im/?Action=ClearCDNTransferRule
&StreamId=rtc01
&Sequence=1617249600003
&<Public Request Parameters>

5 Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.
Data	Object	Returned data.

6 Sample response

{
    "Code":0,
    "Message":"ok",
    "RequestId":"4741109603321226039",
    "Data":null
}

7 Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return Code	Description	Handling Suggestions
5000, 5001, 5002, 5006, 30003	Internal error.	Please contact ZEGOCLOUD technical support for handling.
5003	Authentication failed.	Please check if the signature Signature is correct.
5004	Invalid CDN address.	Please check if the request parameter CDNUrl is correct.
5005	Invalid request.	Please contact ZEGOCLOUD technical support for handling.
5007, 30002	API call frequency is too high.	Please reduce the API request frequency.
30004	Incorrect parameter isTest.	Please check if the common request parameter isTest is correct.
30005	Invalid AppId.	Please check if the AppId is correct.
30009	Invalid StreamId, stream name is not standardized.	Please check if the StreamId conforms to the stream name coding specifications.