Help Center/ Live/ Cloud Live API Reference/ Stream Management/ Disabling a Stream
Updated on 2026-04-22 GMT+08:00
View PDF

Disabling a Stream

Function

This API is used to disable a stream.

A successful request returns no content, with status code 204.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/stream/blocks

Table 1 Path Parameters

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

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Definition

Domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

app_name

Yes

String

Definition

Application name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

stream_name

Yes

String

Definition

Stream name.

Constraints

The value cannot be a wildcard (*).

Range

Length: 1 to 512 characters

Default Value

N/A

resume_time

No

String

Definition

Time when the stream push is resumed.

Constraints

The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ.

Range

If this parameter is not specified, the default value 7 days is used. The maximum value is 90 days. resume_time must be later than the current time.

Default Value

It is 7 days by default.

Response Parameters

Status code: 204

Stream disabled successfully.

Status code: 400

Table 4 Response body parameters

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.

Parent Topic: Stream Management