指定されたドメイン名、またはドメイン名配下の指定されたアプリケーションのすべてのアクティブなアップストリーミングの情報を照会します。
操作説明
この操作は以下のストリームタイプをサポートしています:
-
all: すべてのストリームを照会します。
-
raw: 生ストリームを照会します。
-
trans: トランスコード済みストリームを照会します。
QPS 制限
単一ユーザーの QPS 制限は 1 分あたり 10,000 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切な周波数で呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeLiveStreamsOnlineList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| DomainName |
string |
必須 |
ストリーマーのストリーミングドメイン。 説明
|
example.com |
| AppName |
string |
任意 |
ストリームが属するアプリケーションの名前。AppName はストリーム管理ページで確認できます。 |
liveApp**** |
| StreamName |
string |
任意 |
ストリーム名。単一の StreamName のみ指定できます。StreamName はストリーム管理ページで確認できます。 |
liveStream**** |
| OnlyStream |
string |
任意 |
指定されたフィールドのみを返すかどうかを指定します。有効な値:
|
no |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。有効な値: 1～3000。デフォルト値: 2000。 |
1500 |
| PageNum |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| StreamType |
string |
任意 |
ストリームタイプ。有効な値:
列挙値:
|
all |
| QueryType |
string |
任意 |
ストリーム名にあいまい一致を使用するかどうかを指定します。有効な値:
列挙値:
|
fuzzy |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
アクティブなアップストリーミングの情報。 |
||
| RequestId |
string |
リクエスト ID。 |
5c6a2a0df228-4a64- af62-20e91b9676b3 |
| TotalPage |
integer |
総ページ数。 |
2 |
| PageNum |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| TotalNum |
integer |
指定された条件を満たすエントリの総数。 |
11 |
| OnlineInfo |
object |
||
| LiveStreamOnlineInfo |
array<object> |
アップストリーミング中のストリームの情報。 |
|
|
object |
アップストリーミング中のストリームの情報。 |
||
| AudioDataRate |
integer |
ライブストリームのオーディオ ビットレート。単位: Kbps。 説明
このパラメータは、 アプリケーション をホワイトリストに追加するためのチケットを送信した後にのみ使用できます。チケットの送信方法については、「お問い合わせ」を参照してください。 |
600 |
| FrameRate |
integer |
フレームレート。単位: 1 秒あたりのフレーム数 (fps)。 |
15 |
| PublishUrl |
string |
完全な アップストリーミング URL。 |
rtmp://demo.aliyundoc.com/live/test**** |
| StreamName |
string |
ストリーム名。 |
liveStream**** |
| AudioCodecId |
integer |
オーディオ コーデック ID。 |
10 |
| Height |
integer |
ビデオ解像度の高さ。単位: ピクセル。 |
720 |
| VideoDataRate |
integer |
ライブストリームのビデオ ビットレート。単位: Kbps。 説明
このパラメータは、 アプリケーション をホワイトリストに追加するためのチケットを送信した後にのみ使用できます。チケットの送信方法については、「お問い合わせ」を参照してください。 |
600 |
| DomainName |
string |
ストリーミング ドメイン。 |
example.com |
| PublishDomain |
string |
アップストリーミング ドメイン。ライブセンター アップストリーミング を使用する場合は、ストリーミング ドメインを指定できます。 |
demo.aliyundoc.com |
| PublishTime |
string |
ストリーム アップストリーミング が開始された時刻。時刻の形式は yyyy-MM-ddTHH:mm:ssZ です。時刻は UTC で表示されます。 |
2021-08-09T02:37:59Z |
| AppName |
string |
ストリームが属する アプリケーション の名前。 |
liveApp**** |
| PublishType |
string |
アップストリーミングタイプ。有効な値：
|
edge |
| VideoCodecId |
integer |
ビデオ コーデック ID。 |
7 |
| Transcoded |
string |
ストリームがトランスコードされたストリームかどうかを示します。有効な値：
|
no |
| Width |
integer |
ビデオ解像度の幅。単位: ピクセル。 |
1280 |
| ClientIp |
string |
アップストリーミング クライアントの IP アドレス 。 |
106.11.XX.XX |
| ServerIp |
string |
インジェスト ノードの IP アドレスです。 |
120.221.XX.XX |
例
成功レスポンス
JSONJSON
{
"RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
"TotalPage": 2,
"PageNum": 1,
"PageSize": 10,
"TotalNum": 11,
"OnlineInfo": {
"LiveStreamOnlineInfo": [
{
"AudioDataRate": 600,
"FrameRate": 15,
"PublishUrl": "rtmp://demo.aliyundoc.com/live/test****",
"StreamName": "liveStream****",
"AudioCodecId": 10,
"Height": 720,
"VideoDataRate": 600,
"DomainName": "example.com",
"PublishDomain": "demo.aliyundoc.com",
"PublishTime": "2021-08-09T02:37:59Z",
"AppName": "liveApp****",
"PublishType": "edge",
"VideoCodecId": 7,
"Transcoded": "no",
"Width": 1280,
"ClientIp": "106.11.XX.XX",
"ServerIp": "120.221.XX.XX"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | QpsOverLimit | Qps is over limit for this domainName. | |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | |
| 400 | Duration.Exceed | Duration between StartTime and EndTime is too long. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。