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

:ListMediaWorkflowExecutions

最終更新日:May 08, 2025

メディアワークフローの実行インスタンスをクエリします。

使用上の注意

この操作は、過去 90 日間の実行インスタンスのみを返します。

QPS 制限

この操作は、アカウントごとに 1 秒あたり最大 100 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が生じる可能性があります。この操作を呼び出す際は、制限に注意することをお勧めします。詳細については、「QPS 制限」をご参照ください。

デバッグ

OpenAPI Explorer は、署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ タイプ 必須 説明
Action String Yes ListMediaWorkflowExecutions

実行する操作。値を ListMediaWorkflowExecutions に設定します。

MediaWorkflowId String No 43b7335a4b1d4fe883670036affb****

実行インスタンスをクエリするメディアワークフローの ID。ワークフロー ID を取得するには、ApsaraVideo Media Processing (MPS) コンソール にログインし、ワークフロー > ワークフロー設定 を選択します。

MediaWorkflowName String No example-mediaworkflow-****

メディアワークフローの名前。ワークフロー名を取得するには、MPS コンソール にログインし、ワークフロー > ワークフロー設定 を選択します。

InputFileURL String No http://example-****.cn-hangzhou.aliyuncs.com/test****.flv

メディアワークフローの入力ファイルの Object Storage Service (OSS) URL。URL は RFC 3986 に準拠し、UTF-8 でエンコードされます。予約文字はパーセントエンコードされます。

NextPageToken String No 39f8e0bc005e4f309379701645f4****

クエリ結果の次のページを取得するために使用されるトークン。値は 32 ビット UUID です。クエリ結果の最初のページをリクエストする場合は、NextPageToken パラメータを空のままにします。さらにクエリ結果をリクエストする場合は、前のページのクエリ結果で返された NextPageToken パラメータの値を指定します。

MaximumPageSize Long No 1

返すメディアワークフロー実行インスタンスの最大数。有効な値: [1,100]。デフォルト値: 10

レスポンスパラメータ

パラメータ タイプ 説明
MediaWorkflowExecutionList MediaWorkflowExecution の配列

メディアワークフロー実行インスタンスのリスト。

MediaWorkflowExecution
CreationTime String 2016-04-01T06:53:43Z

実行インスタンスが作成された時刻。

MediaWorkflowId String 43b7335a4b1d4fe883670036affb****

メディアワークフローの ID。

State String Success

実行インスタンスのステータス。有効な値:

  • running: 実行インスタンスは実行中です。
  • Completed: 実行インスタンスは完了しています。
説明 Completed の値は、実行インスタンスが完了したことを示します。トランスコードやスナップショットなどの各アクティビティが成功したかどうかの情報については、アクティビティのステータスを確認してください。
  • Fail: 実行インスタンスは失敗しました。
  • Success: 実行インスタンスは成功しました。
ActivityList Activity の配列

メディアワークフローで実行されるアクティビティのリスト。

Activity
EndTime String 2016-04-01T06:54:00Z

アクティビティの終了時刻。

Type String Start

メディアワークフローアクティビティのタイプ。有効な値: Start、Snapshot、Transcode、Analysis、Report。詳細については、「メディアワークフローアクティビティ」をご参照ください。

StartTime String 2016-04-01T06:53:45Z

アクティビティの開始時刻。

State String Success

アクティビティのステータス。有効な値:

  • Running: アクティビティは実行中です。
  • Fail: アクティビティの実行に失敗しました。
  • Skipped: アクティビティはスキップされました。
  • Success: アクティビティは正常に実行されました。
説明 たとえば、高解像度と標準解像度のトランスコードアクティビティは、分析アクティビティが完了した後に実行されます。システムは、分析結果に基づいて実行するアクティビティを決定します。入力ビデオコンテンツの解像度が不十分な場合、高解像度トランスコードアクティビティはスキップされる可能性があります。
JobId String 2376030d9d0849399cd20e20c876****

アクティビティの実行時に生成されたジョブの ID。後続の他の操作の呼び出しのために、この ID を保存することをお勧めします。

Code String null

返されたエラーコード。

  • アクティビティステータスが Fail の場合、特定のエラーコードが表示されます。
  • アクティビティステータスが Success の場合、このパラメータは返されません。
Message String null

返されたエラーメッセージ。

  • アクティビティステータスが Fail の場合、詳細なエラーメッセージが表示されます。
  • アクティビティステータスが Success の場合、このパラメータは返されません。
Name String Act-2

メディアワークフローアクティビティの名前。

説明 メディアワークフローのアクティビティの名前は一意です。
MNSMessageResult Object

ジョブ結果をユーザーに通知するために Message Service (MNS) によって送信されたメッセージ。

MessageId String 4f3bc83233de4e2f81c7dade443e****

成功メッセージの ID。ジョブが失敗した場合、このパラメータは返されません。

ErrorMessage String MessageConfigEmpty

ジョブが失敗したときに返されるエラーメッセージ。ジョブが成功した場合、このパラメータは返されません。

ErrorCode String The Topic/Queue config is empty, not send message

ジョブが失敗したときに返されるエラーコード。ジョブが成功した場合、このパラメータは返されません。

Name String example-mediaworkflow-****

メディアワークフローの名前。

Input Object

メディアワークフローのカスタムデータ。

UserData String example data

カスタムデータ。

InputFile Object

OSS 内のメディアワークフローの入力ファイルのストレージ場所に関する情報。

Object String example-mediaWorkflow-****/example-object-****/example.mp4

入力ファイルとして使用される OSS オブジェクトの名前。

Location String cn-shanghai

入力ファイルが存在する OSS リージョンの ID。

Bucket String example-bucket-****

入力ファイルが格納されている OSS バケットの名前。

MediaId String 512046582a924698a41e0f8b0d2b****

メディアファイルの ID。このメディアファイル ID は、メディアワークフローによって生成されたすべての情報に関連付けられています。

RunId String 48e33690ac19445488c706924321****

実行インスタンスの ID。

RequestId String D1D5C080-8E2F-5030-8AB4-13092F17631B

リクエストの ID。

NextPageToken String 39f8e0bc005e4f309379701645f4****

クエリ結果の次のページを取得するために使用されるトークン。

リクエストの例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ListMediaWorkflowExecutions
&MediaWorkflowId=43b7335a4b1d4fe883670036affb****
&MediaWorkflowName=example-mediaworkflow-****
&InputFileURL=http://example-****.cn-hangzhou.aliyuncs.com/test****.flv
&NextPageToken=39f8e0bc005e4f309379701645f4****
&MaximumPageSize=1
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListMediaWorkflowExecutionsResponse>
    <MediaWorkflowExecutionList>
        <CreationTime>2016-04-01T06:53:43Z</CreationTime>
        <MediaWorkflowId>43b7335a4b1d4fe883670036affb****</MediaWorkflowId>
        <State>Success</State>
        <ActivityList>
            <EndTime>2016-04-01T06:54:00Z</EndTime>
            <Type>Start</Type>
            <StartTime>2016-04-01T06:53:45Z</StartTime>
            <State>Success</State>
            <JobId>2376030d9d0849399cd20e20c876****</JobId>
            <Code>null</Code>
            <Message>null</Message>
            <Name>Act-2</Name>
            <MNSMessageResult>
                <MessageId>4f3bc83233de4e2f81c7dade443e****</MessageId>
                <ErrorMessage>MessageConfigEmpty</ErrorMessage>
                <ErrorCode>The Topic/Queue config is empty, not send message</ErrorCode>
            </MNSMessageResult>
        </ActivityList>
        <Name>example-mediaworkflow-****</Name>
        <Input>
            <UserData>example data</UserData>
            <InputFile>
                <Object>example-mediaWorkflow-****/example-object-****/example.mp4</Object>
                <Location>cn-shanghai</Location>
                <Bucket>example-bucket-****</Bucket>
            </InputFile>
        </Input>
        <MediaId>512046582a924698a41e0f8b0d2b****</MediaId>
        <RunId>48e33690ac19445488c706924321****</RunId>
    </MediaWorkflowExecutionList>
    <RequestId>D1D5C080-8E2F-5030-8AB4-13092F17631B</RequestId>
    <NextPageToken>39f8e0bc005e4f309379701645f4****</NextPageToken>
</ListMediaWorkflowExecutionsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "MediaWorkflowExecutionList" : [ {
    "CreationTime" : "2016-04-01T06:53:43Z",
    "MediaWorkflowId" : "43b7335a4b1d4fe883670036affb****",
    "State" : "Success",
    "ActivityList" : [ {
      "EndTime" : "2016-04-01T06:54:00Z",
      "Type" : "Start",
      "StartTime" : "2016-04-01T06:53:45Z",
      "State" : "Success",
      "JobId" : "2376030d9d0849399cd20e20c876****",
      "Code" : "null",
      "Message" : "null",
      "Name" : "Act-2",
      "MNSMessageResult" : {
        "MessageId" : "4f3bc83233de4e2f81c7dade443e****",
        "ErrorMessage" : "MessageConfigEmpty",
        "ErrorCode" : "The Topic/Queue config is empty, not send message"
      }
    } ],
    "Name" : "example-mediaworkflow-****",
    "Input" : {
      "UserData" : "example data",
      "InputFile" : {
        "Object" : "example-mediaWorkflow-****/example-object-****/example.mp4",
        "Location" : "cn-shanghai",
        "Bucket" : "example-bucket-****"
      }
    },
    "MediaId" : "512046582a924698a41e0f8b0d2b****",
    "RunId" : "48e33690ac19445488c706924321****"
  } ],
  "RequestId" : "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "NextPageToken" : "39f8e0bc005e4f309379701645f4****"
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。