DescribeRtcCloudTranscode API リファレンスとパラメータ - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

クラウドトランスコード中タスクを照会します。

今すぐお試しください

この 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:DescribeRtcCloudTranscode

none

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。値には大文字と小文字の英字、数字、アンダースコア、ハイフン (-) を含めることができ、最大値は 64 文字です。	******-7074--9ef5-85c19a4***
TaskId	string	必須	クラウドトランスコード中タスク ID。値には大文字と小文字の英字、数字、アンダースコア、ハイフン (-) を含めることができ、最大値は 64 文字です。	****73-8501--8ac1-72295a****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	****3B-0E1A-586A-AC29-742247****
TaskInfo	object	クラウドトランスコード中タスクの詳細。
AppId	string	アプリケーション ID。	******-7074--9ef5-85c19a4***
ChannelId	string	チャンネル ID。	myChannel
TaskId	string	クラウドトランスコード中タスク ID。	****73-8501--8ac1-72295a****
Status	string	クラウドトランスコード中タスクのステータス。有効な値: STARTING RUNNING RECOVERING STOPPED。	RUNNING
InputParam	object	サブスクリプション入力パラメーター。
SingleSubUserParam	object	単一のストリームをサブスクライブするための入力パラメーターです。
UserId	string	サブスクライブするユーザーの ID です。	userA
StreamType	integer	サブスクライブしているユーザーのストリームのメディアタイプです。	0
SourceType	integer	サブスクライブしているビデオ入力ストリームのタイプです。	0
OutputParams	array<object>	トランスコード中出力パラメーター。
	object	トランスコード中出力パラメーター。
ChannelId	string	トランスコーディングされたストリームのプッシュ先チャンネルのIDです。	myChannel
UserId	string	トランスコーディングされたストリームをチャンネルにプッシュするためのユーザーIDです。	userA_360p
UserToken	string	トランスコーディングされたストリームをチャンネルにプッシュするために必要なユーザートークンです。	eyJhcHBpZCI********
TranscodeTemplate	string	トランスコードテンプレートの名前です。	lhd
MaxIdleTime	integer	アイドルタイムアウト期間。タスクが MaxIdleTime の値より長くアイドル状態のままの場合、タスクは自動的に停止されます。単位: 秒。有効な値: 10～14400 (最大値 4 時間)。デフォルト値: 300。	600

例

成功レスポンス

JSONJSON

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TaskInfo": {
    "AppId": "********-7074-****-9ef5-85c19a4*****",
    "ChannelId": "myChannel",
    "TaskId": "******73-8501-****-8ac1-72295a******",
    "Status": "RUNNING",
    "InputParam": {
      "SingleSubUserParam": {
        "UserId": "userA",
        "StreamType": 0,
        "SourceType": 0
      }
    },
    "OutputParams": [
      {
        "ChannelId": "myChannel",
        "UserId": "userA_360p",
        "UserToken": "eyJhcHBpZCI********",
        "TranscodeTemplate": "lhd"
      }
    ],
    "MaxIdleTime": 600
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter%s	%s.
400	MissingParameter%s	%s.
400	TooManyRequests	%s.
500	InternalError	%s.
403	Forbidden	%s.
404	NotFound%s	%s.

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

変更履歴

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