すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLivePullToPush

    ドキュメントセンター

    ApsaraVideo Live:DescribeLivePullToPush

    最終更新日:Aug 26, 2026

    ストリームフェッチングからプッシュへのタスクを照会します。

    操作説明

    • ストリームフェッチングからプッシュへのタスクをクエリします。

    • 指定された ID のタスクの構成およびステータス情報をクエリできます。

    QPS 制限

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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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-shenzhen :

      深セン。

    • cn-qingdao :

      青島。

    • preregion :

      プレリリース。

    • cn-beijing :

      北京。

    • cn-shanghai :

      上海。

    • ap-southeast-1 :

      シンガポール。

    • eu-central-1 :

      ドイツ (フランクフルト)

    • ap-northeast-1 :

      日本 (東京)

    • ap-southeast-5 :

      インドネシア。

    • me-central-1 :

      サウジアラビア (リヤド)

    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: ApsaraVideo 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 コールバック URL。

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

    integer

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

    説明

    • 最初のフレームを基準として読み取りを開始する位置を示します。

    • このパラメーターは、ビデオオンデマンドリソースまたはビデオファイルに対してのみ有効です。

    0
    FileIndex

    integer

    ファイルインデックス。n 番目のファイルから再生が開始されます。

    0
    RetryCount

    integer

    リトライ回数。

    3
    RetryInterval

    integer

    再試行間隔。単位: 秒。

    60
    RepeatNumber

    integer

    完了後に再生が繰り返される回数。有効な値:

    • 0 (デフォルト): 繰り返し再生なし。

    • -1: 無限ループ。

    • その他の正の整数: 完了後に再生が繰り返される回数。

    説明

    このパラメーターは、ビデオオンデマンドまたはサードパーティのビデオストリームにのみ適用されます。

    0
    ReqAuth

    string

    AuthKey

    string

    NotifyItemSwitch

    string

    例

    成功レスポンス

    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,
    "ReqAuth": "",
    "AuthKey": "",
    "NotifyItemSwitch": ""
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter %s. パラメーターが無効です。
    400 CodeInvalidAliUid This aliuid does not have a live domain name. この aluid に対応するライブストリーミングドメインが存在しません。
    400 CodeTaskNotExist Task does not exist. タスクが存在しません。
    500 InternalError %s. 内部エラーが発生しました。後でもう一度お試しください。

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

    変更履歴

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