Alibaba Cloud CLIを使用してApsaraVideo LiveのAPI操作を呼び出す - ApsaraVideo Live

Alibaba Cloud CLIは、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、ApsaraVideo Liveリソースの自動管理とメンテナンスを実装できます。このトピックでは、Alibaba Cloud CLIを使用してApsaraVideo LiveのAPI操作を呼び出す方法について説明します。この例では、DescribeLiveUserDomains操作を呼び出して、アカウント内のApsaraVideo Liveのドメイン名を照会します。

始める前に

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

ステップ1: Alibaba Cloud CLIのインストール

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

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

Cloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Alibaba Cloud CLIはCloud Shellに組み込まれており、定期的にソフトウェアバージョンを更新します。詳細については、「Cloud Shellとは」をご参照ください。

ステップ2: Alibaba Cloud CLIの設定

重要

Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPIを管理およびアクセスする権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) IDを作成し、最小権限の原則に基づいてRAM IDに必要な権限を付与し、RAM IDを使用してAPI操作を呼び出すことをお勧めします。 ApsaraVideo Liveでサポートされているポリシーの詳細については、「ApsaraVideo Liveシステムポリシー」および「ApsaraVideo Liveカスタムポリシー」をご参照ください。

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

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

ステップ3: CLIコマンドを生成する

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

ステップ4: APIの呼び出しApsaraVideo Live

例1: Alibaba Cloud CLIを使用したApsaraVideo LiveのサポートされているAPI操作のクエリ

次の例は、-- helpオプションを使用してApsaraVideo LiveのサポートされているAPI操作を照会する方法を示しています。サポートされているAPI操作は、関数別の操作の一覧でも表示できます。

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

例2: アカウント内のApsaraVideo Liveのすべてのドメイン名の照会

次の例は、Alibaba Cloud CLIを使用してApsaraVideo LiveのDescribeUserDomains操作を呼び出し、アカウント内のすべてのドメイン名を照会する方法を示しています。

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

aliyun live DescribeLiveUserDomains --LiveDomainType liveVideo

コマンド出力を表示します。

{
  "Domains": {
    "PageData": [
      {
        "Cname": "learn.developer.aliyundoc.com",
        "Description": "test",
        "DomainName": "demo.aliyundoc.com",
        "GmtCreated": "2017-08-29T12:15:36Z",
        "GmtModified": "2017-12-29T12:15:36Z",
        "LiveDomainStatus": "online",
        "LiveDomainType": "liveVideo",
        "RegionName": "cn-beijing",
        "ResourceGroupId": ""
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 100,
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
  "TotalCount": 1
}

説明

ApsaraVideo LiveのAPIを呼び出した後にエラーが返された場合は、エラーコードに基づいて入力パラメーターと値が有効かどうかを確認してください。

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