DescribeLiveStreamState でライブストリームの状態を監視 - LIVE

操作説明

ライブストリーミングドメイン名を取得した後、この操作を呼び出して単一ストリームのリアルタイムステータスを照会できます。オフラインステータスの詳細については、アップストリーミングコールバックによって返されるデータを使用してください。この操作では、オフラインステータスの内訳は提供されません。

QPS 制限

1 ユーザーあたりの 1 秒あたりのクエリ数 (QPS) 制限は 100 です。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響が及ぶ可能性があります。この操作は、適切な頻度で呼び出すことを推奨します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:DescribeLiveStreamState

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
DomainName	string	必須	アップストリーミングドメインまたはストリーミングドメイン。	demo.aliyundoc.com
AppName	string	必須	ライブストリームを含むアプリケーションの名前。詳細については、「ストリーム管理」をご参照ください。	liveApp****
StreamName	string	必須	ライブストリームの名前。詳細については、「ストリーム管理」をご参照ください。	liveStream****

レスポンスフィールド

フィールド	型	説明	例
	object
Type	string	アップストリーミングメソッド。有効な値： push：アップストリーミング。 pull：トリガーされたストリームフェッチング。	push
RequestId	string	リクエスト ID。	CE6CD79D-0A98-1F22-A15F-FADA74DF2729
StreamState	string	ストリームの状態。有効な値： online：ストリームはアクティブです。 offline：ストリームはオフラインです。これは、アップストリーミングが失敗したか終了したことを意味する場合があります。詳細については、アップストリーミングコールバックによって返されるデータを使用してください。この操作では、オフラインステータスの詳細な内訳は提供されません。	online

例

成功レスポンス

JSONJSON

{
  "Type": "push",
  "RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729",
  "StreamState": "online"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParam	Parameter invalid.
500	InternalError	The request processing has failed due to backend service exception.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。