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

Querying Disabled Streams

Function

This API is used to query disabled streams.

Calling Method

For details, see Calling APIs.

URI

GET /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.
Table 2 Query 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

No

String

Definition

Application name.

Constraints

If this parameter is not specified, the system will query all disabled streams across all applications for the specified domain.

Range

Length: 1 to 128 characters

Default Value

N/A

stream_name

No

String

Definition

Stream name.

Constraints

N/A

Range

Length: 1 to 512 characters

Default Value

N/A

page

No

Integer

Definition

Page number.

Constraints

N/A

Range

N/A

Default value:

0

size

No

Integer

Definition

Number of records on each page.

Constraints

N/A

Value range:

1~100

Default value:

10

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Definition

Total number of elements in the query result.

Range

N/A

blocks

Array of StreamForbiddenList objects

Definition

List of disabled streams.
Table 5 StreamForbiddenList

Parameter

Type

Description

app_name

String

Definition

Application name.

Range

Length: 1 to 128 characters

stream_name

String

Definition

Stream name.

Range

Length: 1 to 512 characters

resume_time

String

Definition

Time when the stream is resumed. 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.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Queries disabled streams.

GET https://{endpoint}/v1/{project_id}/stream/blocks?domain=publish.example.huawei.com&app_name=live

Example Responses

Status code: 200

Disabled streams queried successfully.

{
  "total" : 2,
  "blocks" : [ {
    "app_name" : "live",
    "stream_name" : "test_001",
    "resume_time" : "2018-05-19T21:10:15Z"
  }, {
    "app_name" : "live",
    "stream_name" : "test_002",
    "resume_time" : "2018-06-12T20:10:10Z"
  } ]
}

Status code: 400

Failed to query disabled streams.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

200

Disabled streams queried successfully.

400

Failed to query disabled streams.

Error Codes

See Error Codes.

Parent Topic: Stream Management