Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Cloud Video
    • Обзор
    • Управление
    • Решение проблем
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
    • Начало работы с API
      • Overview
        • Overview
        • Get
        • List
        • BatchGet
        • Create
        • Update
        • Delete
        • BatchDelete
        • PerformAction
        • GetStreamKey
        • UpdateStreamKey
  • Аудитные логи Audit Trails
  • История изменений

В этой статье:

  • HTTP request
  • Path parameters
  • Body parameters
  • Response
  • PerformLineActionMetadata
  • Status
  • StreamLine
  • RTMPPushInput
  • RTMPPullInput
  • AutoLine
  1. Справочник API
  2. REST (англ.)
  3. StreamLine
  4. PerformAction

Video API, REST: StreamLine.PerformAction

Статья создана
Yandex Cloud
Обновлена 24 апреля 2025 г.
  • HTTP request
  • Path parameters
  • Body parameters
  • Response
  • PerformLineActionMetadata
  • Status
  • StreamLine
  • RTMPPushInput
  • RTMPPullInput
  • AutoLine

Perform an action on the line.

HTTP requestHTTP request

POST https://video.api.cloud.yandex.net/video/v1/streamLines/{streamLineId}:performAction

Path parametersPath parameters

Field

Description

streamLineId

string

Required field. ID of the line.

Body parametersBody parameters

{
  // Includes only one of the fields `activate`, `deactivate`
  "activate": "object",
  "deactivate": "object"
  // end of the list of possible fields
}

Field

Description

activate

object

Includes only one of the fields activate, deactivate.

deactivate

object

Includes only one of the fields activate, deactivate.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "streamLineId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "channelId": "string",
    "title": "string",
    "thumbnailId": "string",
    // Includes only one of the fields `rtmpPush`, `rtmpPull`
    "rtmpPush": {
      "url": "string"
    },
    "rtmpPull": {
      "url": "string"
    },
    // end of the list of possible fields
    // Includes only one of the fields `manualLine`, `autoLine`
    "manualLine": "object",
    "autoLine": {
      "status": "string"
    },
    // end of the list of possible fields
    "createdAt": "string",
    "updatedAt": "string",
    "labels": "object"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

PerformLineActionMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

StreamLine

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

PerformLineActionMetadataPerformLineActionMetadata

Field

Description

streamLineId

string

ID of the line.

StatusStatus

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

StreamLineStreamLine

Entity that is responsible for the incoming video signal settings.

Field

Description

id

string

ID of the line.

channelId

string

ID of the channel to which this stream line belongs.

title

string

Title of the stream line.

thumbnailId

string

ID of the thumbnail image associated with the stream line..

rtmpPush

RTMPPushInput

Real-Time Messaging Protocol (RTMP) push input settings.

Includes only one of the fields rtmpPush, rtmpPull.

Specifies the input type and settings for the video signal source.

rtmpPull

RTMPPullInput

Real-Time Messaging Protocol (RTMP) pull input type.

Includes only one of the fields rtmpPush, rtmpPull.

Specifies the input type and settings for the video signal source.

manualLine

object

Manual control of stream.

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

autoLine

AutoLine

Automatic control of stream.

Includes only one of the fields manualLine, autoLine.

Specifies the control type of the stream line.

createdAt

string (date-time)

Time when the stream line was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time when the stream line was last updated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Custom labels as key:value pairs. Maximum 64 per resource.

RTMPPushInputRTMPPushInput

Settings for an RTMP (Real-Time Messaging Protocol) push input.
Used when the video stream is pushed to an RTMP server.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol

Field

Description

url

string

RTMP server url.

RTMPPullInputRTMPPullInput

Settings for an RTMP pull input.
Used when the service pulls the video stream from an RTMP source.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol

Field

Description

url

string

RTMP url for receiving video signal.

AutoLineAutoLine

Represents an automatic line type where the stream control is handled automatically.

Field

Description

status

enum (AutoLineStatus)

The status of the automatic line.

  • AUTO_LINE_STATUS_UNSPECIFIED: Auto line status unspecified.
  • DEACTIVATED: The automatic line is deactivated and not currently active.
  • ACTIVE: The automatic line is active and operational.

Была ли статья полезна?

Предыдущая
BatchDelete
Следующая
GetStreamKey
Проект Яндекса
© 2025 ООО «Яндекс.Облако»