Disabling a Push Stream
Function
This API is used to disable a push stream.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/stream/blocks
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. The token 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. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
|
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain |
Yes |
String |
Domain name |
|
app_name |
Yes |
String |
Application name. |
|
stream_name |
Yes |
String |
Stream name (not *) |
|
resume_time |
No |
String |
Specifies the time of resuming stream push. The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ. If this parameter is not specified, the default value is 7 days. The maximum value is 90 days. resume_time cannot be earlier than the current time. |
Response Parameters
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
Creates an attribute for forbidding stream push.
POST https://{endpoint}/v1/{project_id}/stream/blocks
{
"domain" : "publish.example.huawei.com",
"app_name" : "live",
"stream_name" : "huawei",
"resume_time" : "2018-05-19T21:10:15Z"
}
Example Responses
Status code: 400
Failed to disable the stream.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
Stream disabled successfully. |
|
400 |
Failed to disable the stream. |
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.
