ライブ冗長冗長グループを使用すると、2 つ以上のライブジョブを 1 つのストリームに統合し、自動フェールオーバーにより、中断のない信頼性の高い再生が可能になります。このガイドでは、Live API を使用した冗長グループの作成、ジョブの追加、フェイルオーバーの強制について説明します。

はじめに

Brightcove Live の冗長性機能は、最初のストリームが機能しなくなった場合に Live が自動的にフェイルオーバーするバックアップストリームを作成することで、ライブイベントの信頼性の高いパフォーマンスを保証するのに役立ちます。

Live API へのすべてのリクエストには、次のヘッダーが必要です。

API リクエストヘッダー
キー	[値]	備考
`X-API-KEY`	{your API Key}	Brightcove Live アカウントを開いたときにキーが提供されているはずです
`Content-Type`	アプリケーション/json	技術的には、`content-type`ヘッダーはリクエスト本体を含む書き込み要求に対してのみ必要ですが、読み取り要求に害を及ぼさないはずです。

ライブジョブを作成する

冗長セットアップの場合は、2 つ以上の Brightcove ライブジョブを作成する必要があります。ジョブの唯一の要件は、output同じ設定で作成することです。これを実現するための最も簡単な方法は、必要な出力仕様でジョブを 1 つ作成し、copy_outputs_from_jobパラメータを使用して追加のジョブを作成することです。

これらのジョブを作成できるリージョンに制限はありませんが、お互いに比較的近くに配置することをお勧めします。

ライブジョブを作成したら、後のためにジョブ ID を保持します。これらのジョブを冗長グループに追加するために使用するリクエストボディは、次のようになります (以下のセクションを参照)。

    [
      {
        "job_id": "0b76bc73f92f46dc917bbe5061c0c633"
      },
      {
        "job_id": "0ae5a4a71dc54b3181af0f98ee407c27"
      }
    ]

冗長グループの作成

冗長グループを作成するには、POST次の要求を送信します。

    https://api.bcovlive.io/v1/redundantgroups

リクエストボディの例を次に示します。

    {
      "ad_insertion": true,
      "processing_regions": ["us-west-2"],
      "storage_regions": ["us-west-2", "us-east-1"],
      "label": "Test RG",
      "live_dvr_sliding_window_duration": 1800
    }

以下の表に、リクエストボディのフィールドの全リストを示します。いくつかのケースでは、これらはライブジョブの作成に使用されるフィールドと同じです。フィールドの詳細については、 Live APIリファレンスを参照してください。

冗長グループフィールドの作成
フィールド	タイプ	必須？	説明
`ad_insertion`	ブール値	オプショナル	このストリームを SSAI を有効にする必要がある場合は true に設定します
`add_cdns`	アレイ	オプショナル	マニフェスト生成に使用される追加の CDN プロバイダーの配列。提供された CDN ごとに、それに応じてマニフェストが先頭に付加されます
`drm`	対象	オプショナル	まだサポートされていません
`encryption`	対象	オプショナル	まだサポートされていません
`label`	ひも	必須	グループを識別するラベル
`live_dvr_sliding_window_duration`	整数	オプショナル
`notifications`	アレイ	オプショナル	通知先オブジェクトまたは文字列の配列
`processing_regions`	アレイ	必須	冗長グループのリージョンの処理。これにより、マニフェストを生成する AWS リージョンが決まります。これは、storage_regions とライブジョブが作成されるリージョンと一致することを推奨します。
`storage_regions`	アレイ	必須	ストレージリージョンのメディアチャンクとプレイリストは S3 にアップロードされます。これは processing_regions とライブジョブが作成されるリージョンと一致することを推奨します。
`videocloud`	対象	オプショナル	Video Cloud のお客様は、ライブストリームに使用するビデオを作成するオプションがあります。

応答は次のようになります。

    {
      "id": "481ff4cf0bf74956bc2ec6e126588080",
      "processing_regions": [
          {
              "region": "us-west-2",
              "probability": 1
          }
      ],
      "storage_regions": [
          "us-west-2",
          "us-east-1"
      ],
      "jobs": [],
      "state": "standby",
      "label": "Test RG",
      "live_dvr_sliding_window_duration": 1800,
      "status": {
          "us-west-2": null
      },
      "ad_insertion": true,
      "outputs": {
          "playback_url": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/playlist.m3u8",
          "playback_url_dvr": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/playlist_dvr.m3u8",
          "ssai_playback_urls": {
              "26f8470f61374e608e27af9c1b3f7ff0": {
                  "playback_url": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/26f8470f61374e608e27af9c1b3f7ff0/playlist_ssaiM.m3u8",
                  "playback_url_dvr": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/26f8470f61374e608e27af9c1b3f7ff0/playlist_dvr_ssaiM.m3u8",
                  "description": "House Ads - 864b84f712ae40bca1510a8052b34312",
                  "type": "ads"
              }
      }
    }

冗長グループの取得

GET以下のリクエストを送信することで、すべての冗長グループを取得できます。

https://api.bcovlive.io/v1/redundantgroups

stateパラメーターを使用して応答をフィルタリングできます。許可される値は次のとおりです。

cancelled
cancelling
deleting
disconnected
failed
finished
finishing
processing
standby
waiting

page_size 1000までの整数に設定できるパラメータもあります。デフォルトは 10 page_sizeです。

レスポンスは次のようになります。

{
  "redundant_groups": [
    {
      "id": "91c268a6ec5240d79a6004f4ccf0dc6f",
      "account_id": "a95ac581551b4478b27910e5675db1f8",
      "user_id": "c2691d4d039040be96c190a949d754a7",
      "processing_regions": [
        {
          "region": "us-west-2",
          "probability": 1
        }
      ],
      "storage_regions": [
        "us-west-2",
        "us-east-1"
      ],
      "jobs": [],
      "state": "standby",
      "created_at": 1594316624287,
      "updated_at": 1594316624287,
      "label": "Test Redundant Group",
      "live_dvr_sliding_window_duration": 86400,
      "status": {
        "us-west-2": null
      },
      "outputs": {
        "playback_url": "https://bcovlive-a.akamaihd.net/r91c268a6ec5240d79a6004f4ccf0dc6f/us-west-2/NA/playlist.m3u8",
        "playback_url_dvr": "https://bcovlive-a.akamaihd.net/r91c268a6ec5240d79a6004f4ccf0dc6f/us-west-2/NA/playlist_dvr.m3u8"
      }
    },
    {
      "id": "279ac36e4b4d48a3abbd3e1f98cd57aa",
      "account_id": "a95ac581551b4478b27910e5675db1f8",
      "user_id": "c2691d4d039040be96c190a949d754a7",
      "processing_regions": [
        {
          "region": "us-west-2",
          "probability": 1
        }
      ],
      "storage_regions": [
        "us-west-2",
        "us-east-1"
      ],
      "jobs": [],
      "state": "standby",
      "created_at": 1594323207015,
      "updated_at": 1594323207015,
      "label": "Test Redundant Group2",
      "live_dvr_sliding_window_duration": 86400,
      "status": {
        "us-west-2": null
      },
      "outputs": {
        "playback_url": "https://bcovlive-a.akamaihd.net/r279ac36e4b4d48a3abbd3e1f98cd57aa/us-west-2/NA/playlist.m3u8",
        "playback_url_dvr": "https://bcovlive-a.akamaihd.net/r279ac36e4b4d48a3abbd3e1f98cd57aa/us-west-2/NA/playlist_dvr.m3u8"
      }
    }
  ]
}

冗長グループにライブジョブを追加する

冗長グループを作成したら、POST次の宛先にリクエストを送信して、そのグループにジョブを追加できます。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}/jobs

ライブジョブ ID は、リクエスト本文で次のように指定します。

    [
      {
        "job_id": "0b76bc73f92f46dc917bbe5061c0c633"
      },
      {
        "job_id": "0ae5a4a71dc54b3181af0f98ee407c27"
      }
    ]

ジョブオブジェクトには、追加のオプションプロパティがいくつかあります。次の表は、すべてのフィールドを示しています。

ライブジョブリクエストフィールドの追加
フィールド	タイプ	必須？	説明
`job_id`	ひも	必須	グループに追加するジョブの ID。`playliststreams`またはが指定されていない場合は、`outputs`すべてが使用されます。
`playlist`	ひも	オプショナル	ストリームの出力として使用するプレイリストのラベル。`playliststreams`が定義されている場合は、未定義。
`streams`	アレイ	オプショナル	ストリームの出力として使用されるストリームラベルのリスト。`streamsplaylist`が定義されている場合は、未定義。

このリクエストの成功応答では、冗長グループ ID が返されます。

冗長グループのステータスを取得する

冗長グループのステータスを取得するには、GETリクエストを以下に送信します。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}

レスポンスは次のようになります。

    {
      "id": "481ff4cf0bf74956bc2ec6e126588080",
      "processing_regions": [
          {
              "region": "us-west-2",
              "probability": 1
          }
      ],
      "storage_regions": [
          "us-west-2",
          "us-east-1"
      ],
      "jobs": [
          {
              "job_id": "0b76bc73f92f46dc917bbe5061c0c633",
              "streams": [
                  "hls720p",
                  "hls540p",
                  "hls360p"
              ],
              "state": "processing"
          },
          {
              "job_id": "0ae5a4a71dc54b3181af0f98ee407c27",
              "streams": [
                  "hls720p",
                  "hls540p",
                  "hls360p"
              ],
              "state": "processing"
          }
      ],
      "state": "processing",
      "created_at": 1568057414849,
      "updated_at": 1568059153017,
      "label": "Test RG",
      "live_dvr_sliding_window_duration": 1800,
      "status": {
          "us-west-2": {
              "SwitchDrift": 0,
              "Ended": false,
              "OnAir": "0b76bc73f92f46dc917bbe5061c0c633",
              "Mode": "auto",
              "InManifest": true,
              "MediaSequence": 10,
              "Healthiness": 0,
              "Duration": 4,
              "DiscontinuitySequence": 1,
              "SourceChunk": {
                  "MediaSequence": 3639,
                  "Duration": 4,
                  "DiscontinuitySequence": 0,
                  "ProgramDateTime": "2019-09-09T19:59:36Z",
                  "LiveJobID": "0b76bc73f92f46dc917bbe5061c0c633"
              },
              "UpdatedAt": "2019-09-09T19:59:46Z",
              "ProgramDateTime": "2019-09-09T19:59:36Z"
          }
      },
      "ad_insertion": true,
      "outputs": {
          "playback_url": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/playlist.m3u8",
          "playback_url_dvr": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/playlist_dvr.m3u8",
          "ssai_playback_urls": {
              "26f8470f61374e608e27af9c1b3f7ff0": {
                  "playback_url": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/26f8470f61374e608e27af9c1b3f7ff0/playlist_ssaiM.m3u8",
                  "playback_url_dvr": "https://playback-qa.a-live.io/r481ff4cf0bf74956bc2ec6e126588080/us-west-2/NA/26f8470f61374e608e27af9c1b3f7ff0/playlist_dvr_ssaiM.m3u8",
                  "description": "House Ads - 864b84f712ae40bca1510a8052b34312",
                  "type": "ads"
              }
          }
      }
    }

冗長グループの各処理領域には、statusリージョンによってキー設定された独自のオブジェクトがあります。この例では、us_west_2処理リージョンでは、on_airジョブが次のように表示されます。0b76bc73f92f46dc917bbe5061c0c633。

補見として、probability処理領域に関連付けられているのはこの時点では常にになりますが1、将来的にはデータモデルに含まれます。0 ～ 1 の確率を持つ複数の処理領域を許可する機能強化により、そのリージョンを使用する再生トラフィックのおおよその割合を表します。

キューポイントを手動で追加する

冗長性を備えたライブストリームにキューポイントを手動で追加することは、通常のライブストリームにキューポイントを追加することと非常によく似ています。冗長グループに対してこれを行うには、POST次の要求を行います。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}/cuepoint

次のようなリクエスト本文を含めます。

    {
      "ad_server_data": {
        "subject": "wildlife"
      },
      "duration": 30,
      "timecode": "09:23:18:05"
    }

timecodeフィールドを省略すると、キューポイントはすぐに挿入されます。

ジョブのフェイルオーバーを強制する

フェールオーバーは Brightcove Live システムによって自動的に管理されるため、ユーザーの介入は必要ありません。ただし、何らかの理由で別のジョブへのフェイルオーバーを強制する場合は、最も簡単な方法は、on_air単にジョブのエンコーダを停止することです。

API PUTを使用して次のリクエストを行って、フェイルオーバーを強制することもできます。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}/switch

リクエスト本文は次のようになります。

    {
      "mode": "manual",
      "on_air": "0ae5a4a71dc54b3181af0f98ee407c27"
    }

ここで、modemanualはまたはauto（デフォルト）のいずれかになり、on_airは、セカンダリジョブ ID の 1 つの値を持ちます。

注:manualモードになると、自動ジョブフェイルオーバーは実行されません。君はしなければならないモードをに戻しますauto自動フェイルオーバーを再開します。オンエアジョブは、本文からモードを省略し、リクエストに force query ?force=trueパラメータを追加することで、手動に切り替えることなく変更できます。これにより、サービスはジョブの切り替えを強制しますが、問題が検出された場合、いつでも元に戻す可能性があります。

冗長ストリームを終了する

冗長ストリームを終了するには 2 つの方法があります。設計上、冗長グループは暗黙的に SEPストリームです。冗長グループからすべてのジョブを削除することで、STANDBY冗長グループをモードにすることができます。

これを行うには、DELETE以下のリクエストを使用します。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}/jobs/{job_id}

削除するジョブごとに。現在のジョブを削除するにはon_air、?force-trueクエリパラメータを追加する必要があることに注意してください。

ストリームを終了する 2 番目の方法は、DELETE次の宛先にリクエストを送信して冗長グループを完全に削除することです。

    https://api.bcovlive.io/v1/redundantgroups/{redundant_group_id}

制限事項

DRM で保護されたライブストリームでは、ライブ冗長性を使用できません。

ページコンテンツ

このページは移動しました。3 秒後に新しい場所に移動します。ブックマークを更新してください！