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

Pausing Stream Push

Function

API for pausing stream push

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:createStreamForbiddenOnce

    Write

    -

    -

    -

    -

URI

POST /v1/{project_id}/stream/block-once

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

Live streaming domain name.

app_name

Yes

String

App name.

stream_name

Yes

String

Stream Name.

Response Parameters

Status code: 204

Stream push paused.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

POST https://{endpoint}/v1/{project_id}/stream/block-once

{
  "domain" : "publish.example.huawei.com",
  "app_name" : "live",
  "stream_name" : "huawei"
}

Example Responses

Status code: 400

Pause stream push failed.

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

Status Codes

Status Code

Description

204

Stream push paused.

400

Pause stream push failed.

Error Codes

See Error Codes.

Parent topic: Stream Management