ListRtcMPUTaskDetail で MPU タスク詳細をクエリ - LIVE - Alibaba Cloud - ApsaraVideo Live

ストリームミキシングおよびリレータスクのパラメーター詳細を照会します。

操作説明

この操作は、ストリームミキシングおよびリレータスクのパラメーター詳細を照会します。API 操作を使用して作成されたストリームミキシングおよびリレータスクのみを照会できます。
ページングクエリの場合、クエリ結果はデフォルトでタスクの更新時間の降順にソートされます。

QPS 制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。制限を超えると、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:ListRtcMPUTaskDetail

list

*All resources.

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。説明アプリケーション ID は、大文字と小文字、数字、アンダースコア、ハイフン (-) で構成され、最大値は 64 文字です。	yourAppId
TaskId	string	任意	タスク ID。説明タスク ID は、大文字と小文字、数字、アンダースコア、ハイフン (-) で構成され、最大値は 55 文字です。タスク ID を指定すると、まずタスク ID に基づいてクエリが実行され、結果には指定されたタスク ID を持つストリームミキシングおよびリレータスクのパラメーター詳細が含まれます。	yourTaskId
PageSize	integer	任意	ページあたりのレコード数。有効な値: 1～100。説明タスク ID を指定しない場合は、PageSize および PageNo パラメーターを指定する必要があります。この場合、指定されたアプリケーション ID 配下のすべてのストリームミキシングおよびリレータスクのページングクエリ結果が返されます。	10
PageNo	integer	任意	ページ番号。説明タスク ID を指定しない場合は、PageSize および PageNo パラメーターを指定する必要があります。この場合、指定されたアプリケーション ID 配下のすべてのストリームミキシングおよびリレータスクのページングクエリ結果が返されます。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	タスクのパラメーター詳細。パラメーターフォーマットは、ストリームミキシングタスクを作成する操作を呼び出す際に使用されるパラメーターフォーマットと同じです。
	array<object>
AppId	string	アプリケーション ID。	yourAppId
ChannelId	string	チャンネル ID。	yourChannelId
TaskId	string	タスク ID。この ID はストリームミキシングおよびリレータスクの識別子です。	yourTaskId
MixMode	string	ストリームミキシングモード。有効な値: 0: ストリームミキシングまたはトランスコーディングなしの単一ストリームリレー。元の単一ストリームのみがリレーされます。ストリームミキシングおよびトランスコーディングのパラメーターを設定する必要はありません。 1 (デフォルト): ストリームミキシング、トランスコーディング、およびリレー。	0
StreamURL	string	ライブストリームのアップストリーミング URL。	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	マルチアドレスリレーのパラメーター。
	object
URL	string	アップストリーミング URL。	rtmp://example.com/live/stream****
IsAliCdn	boolean	ストリームリレーが Alibaba Cloud CDN を使用して実行されるかどうかを示します。有効値： `false`：ストリームリレーは Alibaba Cloud CDN ではない CDN サービスを使用して実行されます。 `true`：ストリームリレーは Alibaba Cloud CDN を使用して実行されます。	false
Region	string	リクエストされたストリームミキシングサービスが存在するリージョン。有効な値: CN-Shanghai: 上海。 AP-Singapore (デフォルト): シンガポール。 EMAA-Saudi: サウジアラビア。	CN-Shanghai
MaxIdleTime	string	アイドルタイムアウト期間。単位: 秒。説明このパラメーターがセットされている場合、タスクが MaxIdleTime より長い時間アイドル状態になると、タスクは自動的に停止します。このパラメーターがセットされていない場合、チャンネルが閉じられるとタスクは直ちに停止します。	10
SingleSubParams	object	単一ストリームリレーのパラメーター。
SourceType	string	ビデオソース。このパラメーターは `StreamType` を 2 に設定した場合にのみ有効です。有効値： `camera` (デフォルト)：カメラを使用してビデオをキャプチャします。 `shareScreen`：画面に表示されているコンテンツをキャプチャします。	camera
StreamType	string	リレーされるストリームのタイプ。有効値： `0` (デフォルト)：オリジナルストリーム。 `1`：音声のみのストリーム。 `2`：映像のみのストリーム。	0
UserId	string	ストリームがリレーされるユーザーの ID。シングルストリームリレーモードでは、1 つのリクエストで 1 つのストリームのみをリレーできます。	yourSubUserId
TranscodeParams	object	ストリームミキシング、トランスコーディング、およびリレーのパラメーター。
Background	object	グローバル背景画像。
RenderMode	string	表示モード。有効値： `0`：ビデオまたは背景画像をペインに合わせて比例的に拡大縮小します。余分なスペースを埋めるために黒帯が追加されます。 `1` (デフォルト)：ビデオまたは背景画像をペインに合わせてトリミングします。	1
URL	string	グローバル背景画像の URL。	yourImageUrl
EncodeParams	object	出力ストリームのエンコーディングパラメーター。
AudioOnly	string	出力ストリームが音声のみのストリームであるかどうかを示します。有効値： `true` `false` (デフォルト)	false
AudioBitrate	string	音声のビットレート。単位：Kbit/s。	128
AudioChannels	string	オーディオチャンネル数。有効値：1 および 2。	2
AudioSampleRate	string	音声サンプリングレート。単位：Hz。	44100
VideoCodec	string	ビデオエンコーディング形式。デフォルト値：H.264。	H.264
VideoBitrate	string	ビデオのビットレート。単位：Kbit/s。	3500
VideoFramerate	string	ビデオのフレームレート。単位：フレーム/秒 (FPS)。	25
VideoGop	string	ビデオの Group of Pictures (GOP) サイズ。	20
VideoHeight	string	ビデオの高さ。単位：ピクセル。	1000
VideoWidth	string	ビデオの幅。単位：ピクセル。	1920
EnhancedParam	string	高度なビデオエンコーディング用のパラメーター。値は JSON 文字列です。オプションのフィールド： `profile`：エンコーディングレベル。ビデオエンコーディング形式が H.264 に設定されている場合、このフィールドの有効値は baseline、main、high です。 `preset`：エンコーディング速度とビデオ品質のトレードオフを調整します。有効値：ultrafast、superfast、veryfast、faster、fast、medium、slow、slower、veryslow、placebo。各値は、エンコーディング速度とビデオ品質のトレードオフのレベルを指定します。たとえば、ultrafast プリセットはエンコーディング速度が最も速いですがビデオ品質は最も低く、placebo プリセットは最高のビデオ品質のためにエンコーディング速度を犠牲にします。	{"profile": "high", "preset": "veryfast"}
Layout	object	ビデオレイアウト情報。説明ビデオレイアウト情報には、ペインの x 座標、y 座標、幅、高さ、レイヤーが含まれます。音声のみのトランスコーディングの場合、ビデオレイアウト情報は返されません。
UserPanes	array<object>	ペインに関する情報。
	array<object>
UserInfo	object	ペインでストリームが再生されるユーザーに関する情報。
SourceType	string	ビデオソース。このパラメーターは `StreamType` を 2 に設定した場合にのみ有効です。有効値： `camera` (デフォルト)：カメラを使用してビデオをキャプチャします。 `shareScreen`：画面に表示されているコンテンツをキャプチャします。	camera
ChannelId	string	ユーザーがいるチャンネルの ID。	yourChannelId
UserId	string	ユーザーの ID。	yourSubUserId
Height	string	ペインの高さ。値は正規化されます。	0.2632
Width	string	ペインの幅。値は正規化されます。	0.3564
X	string	ペインの x 座標。値は正規化されます。	0.2456
Y	string	ペインの y 座標。値は正規化されます。	0.3789
ZOrder	string	ペインのレイヤー。値 0 は、ペインが最下層に配置されることを示します。値が大きいほど、レイヤーが高くなります。	0
BackgroundImageUrl	string	ペインの背景画像の URL。この画像は、ユーザーがカメラをオフにした場合、またはチャンネルに存在しない場合に表示されます。	yourImageUrl
RenderMode	string	表示モード。有効値： `0`：ビデオまたは背景画像をペインに合わせて比例的に拡大縮小します。余分なスペースを埋めるために黒帯が追加されます。 `1` (デフォルト)：ビデオまたは背景画像をペインに合わせてトリミングします。	1
UserInfos	array<object>	ストリームがミキシングされるユーザーに関する情報。空の値が返された場合、すべてのユーザーのストリームがミキシングされます。
	object
ChannelId	string	ユーザーがいるチャンネルの ID。	yourChannelId
UserId	string	ユーザーの ID。	yourSubUserId
SourceType	string	ビデオソース。このパラメーターは `StreamType` を 2 に設定した場合にのみ有効です。有効値： `camera` (デフォルト)：カメラを使用してビデオをキャプチャします。 `shareScreen`：画面に表示されているコンテンツをキャプチャします。	camera
StreamType	string	リレーされるストリームのタイプ。有効値： `0` (デフォルト)：オリジナルストリーム。 `1`：音声のみのストリーム。 `2`：映像のみのストリーム。	0
SeiParams	object	SEI 構成パラメーター。
LayoutVolume	object	レイアウトとボリュームの SEI。戻り値が空の文字列の場合、デフォルトのレイアウトとボリュームの SEI が使用されます。
FollowIdr	string	Instantaneous Decoder Refresh (IDR) フレームに SEI メッセージを追加するかどうかを示します。有効値： `0`：SEI メッセージを追加しません。 `1`：SEI メッセージを追加します。	0
Interval	string	SEI メッセージが追加される間隔。単位：ミリ秒。	1000
PassThrough	object	カスタム SEI。
FollowIdr	string	Instantaneous Decoder Refresh (IDR) フレームに SEI メッセージを追加するかどうかを示します。有効値： `0`：SEI メッセージを追加しません。 `1`：SEI メッセージを追加します。	0
Interval	string	SEI メッセージが追加される間隔。単位：ミリ秒。	1000
PayloadContent	string	カスタム SEI のペイロードコンテンツ。	yourPayloadContent
PayloadContentKey	string	ペイロードコンテンツのキー。デフォルト値：udd。	yourPayloadContentKey
PayloadType	string	カスタムペイロードタイプ。有効値：100～254。デフォルト値：5。	100

例

成功レスポンス

JSONJSON

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "MPUTasks": [
    {
      "AppId": "yourAppId",
      "ChannelId": "yourChannelId",
      "TaskId": "yourTaskId",
      "MixMode": "0",
      "StreamURL": "rtmp://example.com/live/stream****",
      "MultiStreamURL": [
        {
          "URL": "rtmp://example.com/live/stream****",
          "IsAliCdn": false
        }
      ],
      "Region": "CN-Shanghai",
      "MaxIdleTime": "10",
      "SingleSubParams": {
        "SourceType": "camera",
        "StreamType": "0",
        "UserId": "yourSubUserId"
      },
      "TranscodeParams": {
        "Background": {
          "RenderMode": "1",
          "URL": "yourImageUrl"
        },
        "EncodeParams": {
          "AudioOnly": "false",
          "AudioBitrate": "128",
          "AudioChannels": "2",
          "AudioSampleRate": "44100",
          "VideoCodec": "H.264",
          "VideoBitrate": "3500",
          "VideoFramerate": "25",
          "VideoGop": "20",
          "VideoHeight": "1000",
          "VideoWidth": "1920",
          "EnhancedParam": "{\"profile\": \"high\", \"preset\": \"veryfast\"}"
        },
        "Layout": {
          "UserPanes": [
            {
              "UserInfo": {
                "SourceType": "camera",
                "ChannelId": "yourChannelId",
                "UserId": "yourSubUserId"
              },
              "Height": "0.2632",
              "Width": "0.3564",
              "X": "0.2456",
              "Y": "0.3789",
              "ZOrder": "0",
              "BackgroundImageUrl": "yourImageUrl",
              "RenderMode": "1"
            }
          ]
        },
        "UserInfos": [
          {
            "ChannelId": "yourChannelId",
            "UserId": "yourSubUserId",
            "SourceType": "camera",
            "StreamType": "0"
          }
        ]
      },
      "SeiParams": {
        "LayoutVolume": {
          "FollowIdr": "0",
          "Interval": "1000"
        },
        "PassThrough": {
          "FollowIdr": "0",
          "Interval": "1000",
          "PayloadContent": "yourPayloadContent",
          "PayloadContentKey": "yourPayloadContentKey"
        },
        "PayloadType": "100"
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParam	%s.	パラメーター検証に失敗しました。
400	InvalidAppId	%s, please check and try again later.	AppId が無効です。確認して再試行してください。
400	MissingParam	%s, please check and try again later.	必須パラメーターが不足しています。確認して再試行してください。
500	InternalError	%s, please try again later.	内部エラーが発生しました。しばらくしてから再試行してください。
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	必須の権限がありません。確認して再試行してください。

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

変更履歴

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