単一のライブストリームのステータスをリアルタイムで照会します。

使用状況ノート

この操作では、ライブストリームの名前でライブストリームのステータスを照会できます。 ストリームのステータスがオフラインの場合は、レスポンスの詳細を確認してください。

QPS制限

1人のユーザーが1秒あたり最大30件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeLiveStreamState

実行する操作です。 Set the value to DescribeLiveStreamState.

AppName String 必須 liveApp ****

ライブストリームが属するアプリケーションの名前。
DomainName String 必須 demo.aliyundoc.com

取り込みドメインまたはストリーミングドメイン。

StreamName String 必須 liveStream ****

ライブストリームの名前。

RegionId String 任意 cn-shanghai

リージョンの ID

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String CE6CD79D-0A98-1F22-A15F-FADA74DF2729

リクエストの ID です。

StreamState String online

The status of the stream. 設定可能な値は以下のとおりです。

  • online: ストリームが取り込まれていることを示します。
  • offline: ストリームの取り込みが失敗または終了したことを示します。 特定のステータスは、ストリーム取り込みコールバックに基づいて返されます。
  • 禁止: ストリームの取り込みが無効になっていることを示します。
データ型 String プッシュ

ストリーム取り込みのタイプ。 設定可能な値は以下のとおりです。

  • プッシュ: ストリームプッシュ。
  • pull: トリガーされたストリームプル。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeLiveStreamState
&AppName=liveApp ****
&DomainNam e=demo.aliyundoc.com
&StreamName=liveStream ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<DescribeLiveStreamStateResponse>
  <StreamState> オンライン </StreamState>
  <タイプ> プッシュ </タイプ>
  <RequestId>CE6CD79D-0A98-1F22-A15F-FADA74DF2729</RequestId>
</DescribeLiveStreamStateResponse>

JSON 形式 

{
    "DescribeLiveStreamStateResponse": {
        "StreamState": "オンライン" 、
        "タイプ": "プッシュ" 、
        "RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729"
    }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。