Help Center/ Live/ Cloud Live API Reference/ Stream Management/ Querying Disabled Streams
Updated on 2025-11-06 GMT+08:00
View PDF

Querying Disabled Streams

Function

This API is used to query disabled streams.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    live:stream:listStreamForbidden

    Read

    -

    -

    -

    -

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

Domain name

app_name

No

String

Application name. If this parameter is not specified, the disabled streams under all applications for the domain are queried.

stream_name

No

String

Stream name.

page

No

Integer

Page number.

The default value is 0.

size

No

Integer

Number of records on each page.

The value ranges from 1 to 100

The default value is 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

Total number of elements in the query result.

blocks

Array of StreamForbiddenList objects

Information about disabled streams
Table 5 StreamForbiddenList

Parameter

Type

Description

app_name

String

Application name.

stream_name

String

Stream name.

resume_time

String

Time to resume stream push. The format is yyyy-mm-ddThh:mm:ssZ (UTC time). The default value is 7 days. The maximum value is 90 days.

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