指定されたドメイン名のすべてのアクティブな取り込みエンドポイントまたは指定されたドメイン名のアプリケーションのアクティブな取り込みエンドポイントに関する情報を照会します。

使用状況ノート

このインターフェイスは現在、次のストリームタイプをサポートしています。

  • all: すべてのストリームを照会します。
  • raw: 元のストリームを照会します。
  • trans: トランスコードされたストリームを照会します。

QPS制限

1人のユーザーが1分あたり最大10000クエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeLiveStreamsOnlineList

実行する操作です。 値をDescribeLiveStreamsOnlineListに設定します。

DomainName String 必須 example.com

メインのストリーミングドメイン。

AppName String 任意 liveApp ****

ライブストリームが属するアプリケーションの名前。

StreamName String 任意 liveStream ****

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

PageSize Integer 任意 1500

各ページで返されるエントリ数。 有効な値: 1 ~ 3000 デフォルト値: 2000

PageNum Integer 任意 1

返されるページ数。 既定値:1

StreamType String 任意 all

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

  • all: すべてのストリーム。 デフォルト値です。
  • raw: オリジナルストリーム。
  • trans: トランスコードされたストリーム。
QueryType String 任意 ファジー

ストリーム名が一致するモード。 設定可能な値は以下のとおりです。

  • fuzzy: ファジーマッチ。 デフォルト値です。
  • strict: 完全一致。

レスポンスパラメーター

パラメーター データ型 説明
OnlineInfo LiveStreamOnlineInfoの配列

取り込まれるライブストリームに関する情報。

LiveStreamOnlineInfo
DomainName String example.com

メインのストリーミングドメイン。

AppName String liveApp ****

ライブストリームが属するアプリケーションの名前。

StreamName String liveStream ****

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

PublishTime String 2021-08-09T02:37:59Z

ストリームが取り込まれた時刻。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

PublishUrl String rtmp:// push.example.com/live/test****

ストリームの取り込みに使用された完全なURL。

AudioCodecId Integer 10

オーディオコーデックのID。

ClientIp String 106.11.XX.XX

ストリームを取り込むクライアントのIPアドレス。

フレームレート Integer 15

ビットレート。

Height Integer 720

ビデオ解像度の高さ。

PublishDomain String demo.aliyundoc.com

取り込みドメイン。 ライブセンターの取り込みが使用されている場合、ストリーミングドメインを返すことができます。

PublishType String エッジ

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

  • edge: エッジ取り込み。
  • センター: ライブセンターの摂取。
ServerIp String 120.221.XX.XX

取り込みノードのIPアドレス。

トランスコード String no

ストリームがトランスコードされたかどうかを示します。 設定可能な値は以下のとおりです。

  • はい
  • no
VideoCodecId Integer 7

ビデオコーデックのID。

Integer 1280

ビデオ解像度の幅。

PageNum Integer 1

返されたページの数です。

PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

リクエストの ID です。

TotalNum Integer 11

指定された条件を満たすアクティブな取り込みエンドポイントの総数。

TotalPage Integer 2

返されたページの総数。

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList
&AppName=liveApp ****
&<共通リクエストパラメーター>

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

XML 形式

<DescribeLiveStreamsOnlineListResponse>
  <TotalNum>11</TotalNum>
  <TotalPage>2</TotalPage>
  <PageSize>10</PageSize>
  <PageNum>1</PageNum>
  <RequestId>40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>
  <OnlineInfo>
        <LiveStreamOnlineInfo>
              <PublishUrl>rtmp:// demo.aliyundoc.com/live/test****</PublishUrl>
              <FrameRate>15</FrameRate>
              <DomainNam e>example.com</DomainName>
              <ServerIp>120.221.XX.XX</ServerIp>
              <ClientIp>106.11.XX.XX</ClientIp>
              <PublishType> エッジ </PublishType>
              <AppName>liveApp ****</AppName>
              <StreamName>liveStream ****</StreamName>
              <PublishDomai n>demo.aliyundoc.com</PublishDomain>
              <Transcoded>no</Transcoded>
              <高さ> 720</高さ>
              <PublishTime>2021-08-09T02:37:59Z</PublishTime>
              <AudioCodecId>10</AudioCodecId>
              <Width>1280</Width>
              <VideoCodecId>7</VideoCodecId>
        </LiveStreamOnlineInfo>
  </OnlineInfo>
</DescribeLiveStreamsOnlineListResponse>

JSON 形式

{
    "DescribeLiveStreamsOnlineListResponse": {
        "TotalNum": 11、
        "TotalPage": 2、
        "PageSize": 10,
        "PageNum": 1、
        "RequestId": "40A4F36D-A7CC-473A-88E7-154F92242566" 、
        "OnlineInfo": {
            "LiveStreamOnlineInfo": {
                "PublishUrl": "rtmp:// demo.aliyundoc.com/live/test****" 、
                "FrameRate": 15、
                "DomainName": "example.com",
                "ServerIp": "120.221.XX.XX" 、
                "ClientIp": "106.11.XX.XX" 、
                "PublishType": "edge" 、
                "AppName": "liveApp ****" 、
                "StreamName": "liveStream ****" 、
                "PublishDomain": "demo.aliyundoc.com" 、
                "トランスコード": "いいえ" 、
                "高さ": 720、
                "PublishTime": "2021-08-09T02:37:59Z" 、
                "AudioCodecId": 10、
                "幅": 1280、
                "VideoCodecId": 7
            }
        }
    }
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidStartTime.Malformed 指定された StartTime は不正です。 開始時刻の形式が無効な場合に返されるエラーメッセージ。 StartTimeパラメーターの値が有効かどうかを確認します。
400 InvalidEndTime.Malformed 指定された EndTime は不正です。 終了時刻の形式が無効な場合に返されるエラーメッセージ。 EndTimeパラメーターの値が有効かどうかを確認します。

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