Alibaba Cloud CLIを使用してMPSを管理する - ApsaraVideo Media Processing

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

始める前に

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は、Resource Access Management (RAM) ユーザーとして実行することをお勧めします。

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

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

CLIコマンドを生成する

MPSのデバッグページに移動します。
[デバッグ] ページの左側の検索ボックスで、呼び出す 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操作のリストを取得します。機能別の操作リストで呼び出すことができるAPI操作を表示することもできます。

次のコマンドを実行します。
```
aliyun mts --help
```
コマンド出力を表示します。

例 2：Alibaba Cloud CLI を使用して ApsaraVideo Media Processing の QueryMediaInfoJobList オペレーションを呼び出し、メディア情報ジョブをクエリします。 QueryMediaInfoJobList オペレーションの詳細については、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", // パラメーター「*」はJSONオブジェクトの仕様に準拠していません
        "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", // パラメーター「Input」はJSONオブジェクトの仕様に準拠していません
          "ErrorCode": "InvalidParameter.JsonObjectFormatInvalid"
        },
        "Properties": {
          "Width": "1280",
          "Height": "720",
          "Duration": "17.226000",
          "Fps": "25",
          "Bitrate": "1630.045",
          "FileFormat": "QuickTime/MOV",
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [

説明

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

また、返されたリクエスト ID または SDK エラー情報に基づいて、[OpenAPI 問題診断] ページでセルフサービス診断を実行することもできます。