Deleting Channel Information
Function
Deletes channel information.
URI
DELETE /v1/{project_id}/ott/channels
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain |
Yes |
String |
Ingest domain name. |
app_name |
Yes |
String |
Group name or application name. |
id |
Yes |
String |
Channel ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Access-Control-Allow-Internal |
No |
String |
Service authentication token. If authentication is enabled for a service, Access-Control-Allow-Internal must be carried to access the service. |
Access-Control-Allow-External |
No |
String |
Service authentication token. If authentication is enabled for a service, Access-Control-Allow-External must be carried to access the service. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result_code |
String |
Error code. |
result_msg |
String |
Error description. |
domain |
String |
Ingest domain name. |
app_name |
String |
Group name or application name. This parameter is mandatory. |
id |
String |
Unique ID of a channel. This parameter is mandatory. |
sources |
Array of SourceRsp objects |
Ingest URL list. During channel creation, the ingest URL list is returned only when the input stream protocol is RTMP_PUSH. |
Parameter |
Type |
Description |
---|---|---|
url |
String |
RTMP ingest URL. |
bitrate |
Integer |
Bitrate. Unit: bit/s. Value range: 0–104,857,600 (100 Mbit/s) |
width |
Integer |
Width corresponding to the resolution. Value range: 0–4096 (4K) |
height |
Integer |
Height corresponding to the resolution. Value range: 0–2160 (4K) |
enable_snapshot |
Boolean |
Whether to use the stream for snapshot capturing. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
result_code |
String |
Error code. |
result_msg |
String |
Error description. |
domain |
String |
Ingest domain name. |
app_name |
String |
Group name or application name. This parameter is mandatory. |
id |
String |
Unique ID of a channel. This parameter is mandatory. |
Example Requests
DELETE https://{endpoint}/v1/{project_id}/ott/channels?app_name=ott&domain=push.testott.hls.com&id=test
Example Responses
Status code: 200
Demo Information
{ "result_code" : "LIVE.100000000", "result_msg" : "SUCCESS", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" }
Status code: 400
Error response
{ "result_code" : "LIVE.103011019", "result_msg" : "The resource to access is not exists", "domain" : "push.testott.hls.com", "app_name" : "ott", "id" : "test" }
Status Codes
Status Code |
Description |
---|---|
200 |
Demo Information |
400 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot