edit-icon download-icon

ForbidLiveStream

Last Updated: Mar 19, 2018

Description

Forbid publishing a stream. You can set a time to resume streaming.

Request parameters

Parameters Type Required Example values Description
Action String Yes ForbidLiveStream

The name of this interface. Value: ForbidLiveStream

AppName String Yes testApp

Name of the app.

DomainName String Yes www.yourdomain.com

Your Live domain name.

LiveStreamType String Yes publisher

Used to specify whether to adopt stream pushing by the broadcaster or stream pulling by the client. Currently publisher (pushed by the broadcaster) is supported.

StreamName String Yes testStream

Name of the stream.

ResumeTime String No 2015-12-01T17:37:00Z

Time when resume the stream.

  • UTC time, format: 2015-12-01T17:37:00Z.

Return parameters

Parameters Type Example values Description
RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

The ID of the job request.

Example

Request example

  1. https://live.aliyuncs.com/?Action=ForbidLiveStream&DomainName=test101.aliyunlive.com&AppName=app&StreamName=stream1&LiveStreamType=publisher&<Public Request Parameter>

For more information, see Public Request Parameter.

Normal return example

JSONformat

  1. {
  2. "RequestId":"16BFE188-B193-4C3C-ADC5-79A7E31486EA"
  3. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.