すべてのプロダクト
Search
ドキュメントセンター

:DescribeLivePullToPush

最終更新日:Mar 31, 2026

この操作を呼び出して、プル・トゥ・プッシュタスクの情報を照会します。

操作説明

  • この操作を呼び出して、プル・トゥ・プッシュタスクの情報を照会します。

  • タスク ID を指定することで、タスクの構成およびステータスを照会できます。

秒間クエリ数 (QPS) の制限

単一ユーザーによるこの操作の呼び出しは、最大で 10 回/秒 (QPS) まで可能です。この制限を超えると、API 呼び出しがスロットルされます。これにより、業務に影響が出る可能性があります。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:DescribeLivePullToPush

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID。

cn-shanghai

TaskId

string

必須

タスク ID。

fd245384-4067-4f91-9d75-9666a6bc****

Region

string

必須

タスクが実行されるリージョン。有効な値は以下のとおりです:

  • ap-southeast-1(シンガポール)

  • ap-southeast-5(インドネシア)

  • cn-beijing(中国 (北京))

  • cn-shanghai(中国 (上海))

cn-shanghai

レスポンスフィールド

フィールド

説明

object

応答パラメーター

RequestId

string

リクエスト ID。

a05e6b15-15af-405b-a4a2-0152245d****

RetCode

integer

リターンコード。

説明
  • 値が 0 の場合、リクエストは正常に完了しました。

  • その他の値については、本トピックのエラーコードをご参照ください。

0

Description

string

エラーの説明。

OK

TaskId

string

作成されたタスクの ID。

fb0d4ac7-c7e3-4978-9743-0bf2f6e8****

TaskStatus

integer

タスクの現在のステータス:

  • 0:未開始。予定された開始時刻に達していません。

  • 1:実行中。ストリームのプルおよびアップストリーミングが正常です。

  • 2:異常

  • 3:停止済み。ストリームのプルまたはアップストリーミングに異常が発生したか、API 呼び出しによってタスクが停止されました。

  • -1:終了済み

0

TaskInvalidReason

string

タスクが停止した理由:

  • PullStreamFailed:ソースストリームのプル中にエラーが発生しました。システムは再試行しています。

  • PushStreamFailed:送信先ストリームへのアップストリーミング中にエラーが発生しました。システムは再試行しています。

  • UnknownError:不明なエラーが発生しました。

説明

このパラメーターは、タスクが停止している場合のみ返されます。

PullStreamFailed

TaskExitTime

integer

タスクが終了した時刻。これは、秒単位の UNIX タイムスタンプです。

説明

このパラメーターは、タスクが終了した場合のみ返されます。

1726354625

TaskExitReason

string

タスクが終了した理由:

  • TriggerByUser:ユーザーによってタスクが停止されました。

  • OverEndTime:予定された終了時刻に達しました。

説明

このパラメーターは、タスクが終了した場合のみ返されます。

TriggerByUser

CurrentOffset

integer

現在の動画再生オフセット。

0

CurrentFileIndex

integer

現在のプレイリストシーケンスオフセット。

0

TaskInfo

object

タスク情報。

TaskId

string

タスク ID。

fd245384-4067-4f91-9d75-9666a6bc9****

TaskName

string

タスク名。

test

StartTime

string

タスクの開始時刻。形式は yyyy-MM-ddTHH:mm:ssZ で、協定世界時 (UTC) で表示されます。

2024-08-26T10:30:00Z

EndTime

string

タスクの終了時刻。形式は yyyy-MM-ddTHH:mm:ssZ で、協定世界時 (UTC) で表示されます。

2024-08-27T14:30:00Z

SourceType

string

ソースストリームの種類。有効な値は以下のとおりです:

  • live:ライブストリーム。

  • vod:VOD リソース。

  • url:サードパーティの動画ファイルリソース。

vod

SourceProtocol

string

ソースストリームのプロトコル。

RTMP

SourceUrls

array

ソースストリームの URL。

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

string

ソースストリームの URL。

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

DstUrl

string

ストリームのアップストリーミング先 URL です。

rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434

CallbackURL

string

HTTP Webhook URL。

https://callback*****.com

Offset

integer

動画ファイルの開始オフセット。単位:秒。値は 0 より大きい必要があります。

説明
  • このパラメーターは、最初のフレームからの再生開始時刻のオフセットを指定します。

  • このパラメーターは、VOD リソースまたは動画ファイルに対してのみ有効です。

0

FileIndex

integer

ファイルインデックス。ソース URL のリストから、指定されたファイルから再生を開始します。

0

RetryCount

integer

リトライ回数。

3

RetryInterval

integer

再試行間隔。単位:秒。

60

RepeatNumber

integer

ソースの再生終了後に再生を繰り返す回数。有効な値は以下のとおりです:

  • 0(デフォルト):再生を繰り返しません。

  • -1:ストリームを無限にループします。

  • その他の正の整数:再生を繰り返す回数。

説明

このパラメーターは、VOD またはサードパーティの動画ソースに対してのみ有効です。

0

成功レスポンス

JSONJSON

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
  "TaskStatus": 0,
  "TaskInvalidReason": "PullStreamFailed",
  "TaskExitTime": 1726354625,
  "TaskExitReason": "TriggerByUser",
  "CurrentOffset": 0,
  "CurrentFileIndex": 0,
  "TaskInfo": {
    "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****",
    "TaskName": "test",
    "StartTime": "2024-08-26T10:30:00Z",
    "EndTime": "2024-08-27T14:30:00Z",
    "SourceType": "vod",
    "SourceProtocol": "RTMP",
    "SourceUrls": [
      "rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434"
    ],
    "DstUrl": "rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434",
    "CallbackURL": "https://callback*****.com",
    "Offset": 0,
    "FileIndex": 0,
    "RetryCount": 3,
    "RetryInterval": 60,
    "RepeatNumber": 0
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter %s.
400 CodeInvalidAliUid This aliuid does not have a live domain name.
400 CodeTaskNotExist Task does not exist.
500 InternalError %s.

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

変更履歴

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