ApsaraVideo VOD:Alibaba Cloud CLIを使用したリソース管理

始める前に

Alibaba Cloud CLIに慣れてください。 詳細については、「Alibaba Cloud CLI の概要」をご参照ください。

前提条件

Alibaba Cloud アカウントが作成済みであること。 Alibaba Cloudアカウントは、 Alibaba Cloud公式サイト RAMユーザーを作成してAPI操作を呼び出すことを推奨します。 詳細については、「RAMユーザーの作成」をご参照ください。

Alibaba Cloud CLI のインストール

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

• Windowsオペレーティングシステム: Windows

• Linuxオペレーティングシステム: Linux

• macOSオペレーティングシステム: macOS

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

Alibaba Cloud CLI の設定

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなID資格情報をサポートしています。 詳細については、「ID資格情報の種類」をご参照ください。 この例では、AccessKey資格情報が使用されます。 以下の手順を実行します。

1. RAMユーザーを作成し、ビジネス要件に基づいてAlibaba Cloudサービスを管理する権限をRAMユーザーに付与します。 詳細については、「RAMユーザーの作成」および「RAMユーザーへの権限付与」をご参照ください。

2. RAMユーザーのAccessKeyペアを作成し、その後のID資格情報の設定のためにAccessKey IDとAccessKey secretを記録します。 詳細については、「AccessKeyペアの作成」をご参照ください。

3. ID資格情報の設定に使用可能なリージョンのIDを取得して記録します。 Alibaba Cloud CLIは、指定したリージョンIDを使用してAPI呼び出しを開始します。 使用可能なリージョンの詳細については、「エンドポイント」をご参照ください。

   説明

   Alibaba Cloud CLIを使用する場合、-- regionオプションを指定して、特定のリージョンでコマンドを実行できます。 このオプションを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視します。 詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。

4. RAMユーザーのAccessKeyペアを使用して、AkProfileという名前の設定ファイルでAccessKey資格情報を設定します。 詳細については、「設定例」をご参照ください。

CLIコマンドの生成

1. ApsaraVideo VOD APIのデバッグページに移動します。

2. 表示されるページの左側の検索ボックスで、呼び出す操作を検索します。 [パラメーター] タブで、APIドキュメントに基づいてパラメーターを設定します。 右側の [CLIの例] タブをクリックすると、指定されたパラメーターを含む生成されたサンプルCLIコマンドが表示されます。

• [実行] アイコンをクリックします。 Cloud Shellに移動します。 Cloud Shellでコマンドをデバッグできます。

• [コピー] アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。 サンプルコマンドをシェルに貼り付けて実行することもできます。

  • サンプルコマンドをデバッグのためにシェルに貼り付けるときは、パラメータの形式に注意してください。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。

  • デフォルトでは、OpenAPI Explorerで生成されるサンプルコマンドに -- regionオプションが追加されます。 コマンドをローカルシェルにコピーすると、Alibaba Cloud CLIはデフォルトの認証情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンで優先的にコマンドを実行します。 このオプションは、ビジネス要件に基づいて削除または保持できます。

API操作の呼び出し

構文

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

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

コマンドオプション

Alibaba Cloud CLIを使用する場合、コマンドオプションを指定して、コマンドの動作を変更したり、コマンドの拡張機能を実装したりできます。 次の一般的なコマンドオプションが使用されます。

• -- profile <profileName>: -- profileオプションとprofileNameパラメーターを使用して、構成プロファイルを指定できます。 有効な構成プロファイルを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定の情報を無視し、指定した構成を優先的に使用してコマンドを実行します。

• -- help: -- helpオプションを指定して、コマンドに関するヘルプ情報を取得できます。 詳細については、「ヘルプコマンドの使用」をご参照ください。

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

呼び出し例

例1: 次の手順では、-- helpオプションを使用して、Alibaba Cloud CLIでサポートされているApsaraVideo VOD API操作のリストを取得する方法について説明します。 また、関数別の操作の一覧で呼び出すことができるAPI操作を表示することもできます。

1. 以下のコマンドを実行します。

   aliyun vod --help

2. 結果を表示します。

例2: 次の手順では、Alibaba Cloud CLIを使用してApsaraVideo VODのSearchMedia操作を呼び出す方法について説明します。

1. 以下のコマンドを実行します。

   aliyun vod SearchMedia --region cn-shanghai --PageSize 1

2. 結果を表示します。

   {
       "MediaList": [
           {
               "AiData": {},
               "AiRoughData": {},
               "AttachedMedia": {},
               "Audio": {},
               "CreationTime": "2024-08-16T09:36:00Z",
               "Image": {},
               "MediaId": "50798ff*************************",
               "MediaType": "video",
               "Video": {
                   "VideoId": "50798ff*************************"
               }
           }
       ],
       "RequestId": "45D92389-12CA-****-****-************",
       "ScrollToken": "5a0c898*************************",
       "Total": 1409
   }