Alibaba Cloud CLI で API 呼び出しによる MPS ジョブ自動化 - MPS - Alibaba Cloud - ApsaraVideo Media Processing

Alibaba Cloud CLI は、OpenAPI Explorer をベースに開発された汎用コマンドラインツールです。Alibaba Cloud CLI を使用して、ApsaraVideo Media Processing の管理とメンテナンスを自動化できます。このトピックでは、Alibaba Cloud CLI を使用して ApsaraVideo Media Processing を呼び出す方法について説明します。

事前準備

Alibaba Cloud CLI の概要を理解しておいてください。詳細については、「Alibaba Cloud CLI とは」をご参照ください。

Alibaba Cloud CLI のインストール

Alibaba Cloud CLI を使用する前に、Alibaba Cloud CLI をインストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、macOS オペレーティングシステムにインストールできます。お使いのデバイスのオペレーティングシステムに基づいて Alibaba Cloud CLI のインストールパッケージを選択してください。詳細については、次のトピックをご参照ください：

また、Alibaba Cloud が提供する Cloud Shell を使用して、Alibaba Cloud CLI で実行するコマンドをデバッグすることもできます。Cloud Shell の詳細については、「Cloud Shell とは」をご参照ください。

Alibaba Cloud CLI の設定

重要

Alibaba Cloud アカウントは、すべての Alibaba Cloud サービスの API を管理およびアクセスする権限を持っています。Alibaba Cloud アカウントを使用して API を呼び出すと、セキュリティリスクが発生する可能性があります。API の呼び出しや日常の O&M は、RAM ユーザーとして実行することを推奨します。

Alibaba Cloud CLI を使用する前に、ID 認証情報やリージョン ID などの情報を Alibaba Cloud CLI で設定する必要があります。Alibaba Cloud CLI は、さまざまな ID 認証情報をサポートしています。詳細については、「プロファイルの設定」の「認証情報タイプ」セクションをご参照ください。この例では、AccessKey 認証情報を使用します。AccessKey 認証情報を使用するには、次の手順を実行します：

RAM ユーザーを作成し、必要な権限を RAM ユーザーに付与します。詳細については、「RAM ユーザーの作成」および「RAM ユーザーへの権限付与」をご参照ください。
重要
この例では、AliyunMTSFullAccess ポリシーが RAM ユーザーにアタッチされています。カスタムポリシーを使用することもできます。詳細については、「MPS のカスタムポリシー」をご参照ください。
RAM ユーザーの AccessKey ペアを作成し、後続のID認証情報の設定のために AccessKey ID と AccessKey secret を記録します。詳細については、「AccessKey ペアの作成」をご参照ください。
後続のID認証情報の設定のために、利用可能なリージョンの ID を取得して記録します。Alibaba Cloud CLI は、指定されたリージョン ID を使用して API コールを開始します。利用可能なリージョンの詳細については、「エンドポイント」をご参照ください。
説明
Alibaba Cloud CLI を使用する際、--region オプションを指定して、特定のリージョンでコマンドを実行できます。このオプションを指定すると、Alibaba Cloud CLI はデフォルトのプロファイルや環境変数の設定にあるリージョン情報を無視します。詳細については、「API コールのコマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して、AkProfile という名前のプロファイルに AccessKey 認証情報を設定します。詳細については、「プロファイルの設定」の「設定例」セクションをご参照ください。

CLI コマンドの生成

MPS用API Explorer に移動します。
「デバッグ」ページの左側の検索ボックスで、呼び出したい API 操作を検索します。 API 操作の [パラメーター] タブで、API リファレンスに基づいてパラメーターを指定します。右側の [CLI の例] タブをクリックして、指定したパラメーターを含む生成されたサンプルコマンドを表示します。
- アイコンをクリックして Cloud Shell を起動し、Cloud Shell でコマンドをデバッグします。
- アイコンをクリックしてサンプルコマンドをクリップボードにコピーします。次に、サンプルコマンドをローカルシェルに貼り付けて実行します。
  - サンプルコマンドをローカルシェルに貼り付けてデバッグする際は、パラメーターの形式に注意してください。Alibaba Cloud CLI のパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
  - デフォルトでは、OpenAPI Explorer は生成されたサンプルコマンドに --region オプションを追加します。ローカルシェルでコマンドを実行すると、Alibaba Cloud CLI はデフォルトのプロファイルと環境変数の設定にあるリージョン情報を無視し、指定されたリージョンでコマンドを優先的に実行します。ビジネス要件に応じて、このオプションを削除または保持できます。

API オペレーションの呼び出し

構文

Alibaba Cloud CLI では、次の構文を使用してコマンドを実行できます。詳細については、「CLI コマンドの生成と実行」の「構文」セクションをご参照ください。

aliyun <command> <subcommand> [options and parameters]

コマンドオプション

Alibaba Cloud CLI を使用する際、コマンドオプションを指定して、コマンドのデフォルトの動作を変更したり、コマンドの拡張機能を実装したりできます。一般的なコマンドオプションは次のとおりです：

--profile <profileName>：--profile オプションと profileName パラメーターを使用してプロファイルを指定できます。有効なプロファイルを指定すると、Alibaba Cloud CLI はデフォルトのプロファイルと環境変数の設定を無視し、指定したプロファイルを優先的に使用してコマンドを実行します。
--help：--help オプションを使用して、コマンドのヘルプ情報を取得できます。詳細については、「help コマンドの使用」をご参照ください。

詳細については、「API コールのコマンドラインオプション」をご参照ください。

例

例 1： --help オプションを使用して、Alibaba Cloud CLI でサポートされている ApsaraVideo Media Processing のリストを取得します。呼び出し可能な API は、「機能別のオペレーションリスト」でも確認できます。

次のコマンドを実行します：
```
aliyun mts --help
```

コマンドの出力を確認します。

Usage:
  aliyun mts <ApiName> --parameter1 value1 --parameter2 value2 ...
Product: Mts (Media Processing)
Version: 2014-06-18
Available APIs:
  ActivateMediaWorkflow              Activates a media workflow.
  AddMedia                           Submits a job to add a media asset.
  AddMediaTag                        Adds a tag to a media asset.
  AddMediaWorkflow                   Creates a media workflow.
  AddPipeline                        Creates a pipeline.
  AddSmarttagTemplate                Adds a template for a smart tagging job.
  AddTemplate                        Creates a custom template that includes container, video, and audio stream settings.

例 2： Alibaba Cloud CLI を使用して ApsaraVideo Media Processing の QueryMediaInfoJobList API を呼び出し、メディア情報ジョブをクエリします。QueryMediaInfoJobList API の詳細については、「QueryMediaInfoJobList」をご参照ください。

次のコマンドを実行します：

aliyun mts QueryMediaInfoJobList --region cn-hangzhou --MediaInfoJobIds '23ca1d184c0e4341e5b665e2a12****'

コマンドの出力を確認します。

{
  "NonExistMediaInfoJobIds": {
    "String": [
      "11ce1d184c0e4341e5b665e2a12****"
    ]
  },
  "RequestId": "46A04AA5-B119-41BB-B750-7C5327AC3E7A",
  "MediaInfoJobList": {
    "MediaInfoJob": [
      {
        "CreationTime": "2014-01-10T12:00:00Z",
        "State": "Success",
        "JobId": "23ca1d184c0e4341e5b665e2a12****",
        "UserData": "testid-001",
        "Code": "InvalidParameter.JsonObjectFormatInvalid",
        "Message": "The parameter "*" does not conform to the JSON Object specification",
        "PipelineId": "88c6ca184c0e432bbf5b665e2a15****",
        "Async": true,
        "Input": {
          "Object": "example.mp4",
          "Location": "oss-cn-hangzhou",
          "Bucket": "example-bucket"
        },
        "MNSMessageResult": {
          "MessageId": "123",
          "ErrorMessage": "The parameter \\\"Input\\\" does not conform to the JSON Object specification",
          "ErrorCode": "InvalidParameter.JsonObjectFormatInvalid"
        },
        "Properties": {
          "Width": "1280",
          "Height": "720",
          "Duration": "17.226000",
          "Fps": "25",
          "Bitrate": "1630.045",
          "FileFormat": "QuickTime/MOV",
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [
                {
                  "Sar": "1:1",
                  "Height": "1080",
                  "CodecTagString": "[0][0][0][0]",
                  "NetworkCost": {
                    "PreloadTime": "8",
                    "AvgBitrate": "300.34",
                    "CostBandwidth": "10"
                  },
                  "Width": "1920",
                  "Index": "1",
                  "Timebase": "1/1000",
                  "AvgFPS": "23.976025",
                  "PixFmt": "yuv420p",
                  "Lang": "eng",
                  "CodecLongName": "H.264/AVC/MPEG-4 AVC/MPEG-4 part 10",
                  "NumFrames": "100",
                  "Rotate": "180",
                  "Bitrate": "30541090",
                  "HasBFrames": "0",
                  "Profile": "High",
                  "StartTime": "0.042000",
                  "Dar": "16:9",
                  "CodecName": "h264",
                  "Duration": "100",
                  "Fps": "25",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "1001/48000",
                  "Level": "41",
                  "ColorRange": "700",
                  "ColorTransfer": "R255 G83 B170",
                  "ColorPrimaries": "700"
                }
              ]
            },
            "AudioStreamList": {
              "AudioStream": [
                {
                  "Timebase": "1/1000",
                  "Index": "1",
                  "SampleFmt": "fltp",
                  "ChannelLayout": "5.1(side)",
                  "Lang": "eng",
                  "Samplerate": "48000",
                  "CodecLongName": "DCA (DTS Coherent Acoustics)",
                  "Channels": "2",
                  "NumFrames": "123",
                  "Bitrate": "1536000",
                  "CodecTagString": "[0][0][0][0]",
                  "StartTime": "0.042000",
                  "CodecName": "acc",
                  "Duration": "123",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "1/48000"
                }
              ]
            },
            "SubtitleStreamList": {
              "SubtitleStream": [
                {
                  "Timebase": "1/1000",
                  "Index": "3",
                  "StartTime": "0.000000",
                  "CodecName": "ass",
                  "Lang": "eng",
                  "CodecLongName": "ASS (Advanced SSA) subtitle",
                  "Duration": "1370.116000",
                  "CodecTag": "0x0000",
                  "CodecTimeBase": "0/1",
                  "CodecTagString": "[0][0][0][0]"
                }
              ]
            }
          },
          "Format": {
            "StartTime": "0.042000",
            "NumPrograms": "2",
            "Size": "3509895",
            "NumStreams": "1",
            "FormatLongName": "QuickTime/MOV",
            "Duration": "17.226000",
            "Bitrate": "1630.045",
            "FormatName": "mov"
          },
          "FileSize": "3509895"
        }
      }
    ]
  }
}

説明

ApsaraVideo Media Processing を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとその値が有効であるかどうかを確認する必要があります。

また、レスポンスまたは SDK のエラーメッセージからリクエスト ID を記録し、OpenAPI Diagnostics を使用してセルフサービス診断を実行することもできます。