Alibaba Cloud CLI は、OpenAPI をベースに構築された汎用コマンドラインツールです。このツールを使用すると、 ApsaraVideo Live リソースの管理とメンテナンスを自動化できます。このトピックでは、 ApsaraVideo Live で Alibaba Cloud CLI を使用する例として、 DescribeLiveUserDomains API を呼び出してストリーミングドメイン名を照会する方法を順を追って説明します。
事前準備
Alibaba Cloud CLI に精通している必要があります。詳細については、「Alibaba Cloud CLI とは」をご参照ください。
ステップ 1: Alibaba Cloud CLI のインストール
お使いのデバイスに Alibaba Cloud CLI をインストールします。オペレーティングシステムに一致するインストールパッケージを選択してください:
または、 Cloud Shell で CLI コマンドをデバッグすることもできます。Cloud Shell には Alibaba Cloud CLI が組み込まれており、常に最新の状態に保たれています。詳細については、「Cloud Shell とは」をご参照ください。
ステップ 2: Alibaba Cloud CLI の設定
Alibaba Cloud アカウントは、すべてのサービス API へのフルアクセス権限を持っているため、セキュリティ上のリスクがあります。Resource Access Management (RAM) アイデンティティを作成し、最小権限の原則に基づいて必要な権限のみを付与してから、その RAM アイデンティティを使用して API オペレーションを呼び出すことを推奨します。ApsaraVideo Live がサポートするポリシーの詳細については、「ApsaraVideo Live のシステムポリシー」および「ApsaraVideo Live のカスタムポリシー」をご参照ください。
Alibaba Cloud CLI を使用する前に、ID 認証情報とリージョン ID を設定します。Alibaba Cloud CLI は、さまざまな認証情報タイプをサポートしています。詳細については、「認証情報の種類」をご参照ください。この例では、AccessKey ペアを使用します。
-
RAM ユーザーを作成し、その RAM ユーザーの AccessKey ペアを作成して、ID 認証情報を設定します。詳細については、「RAM ユーザーの作成」および「AccessKey ペアの作成」をご参照ください。
-
RAM ユーザーに必要な権限を付与します。この例では、
AliyunLiveReadOnlyAccessポリシーを RAM ユーザーにアタッチします。このポリシーは、RAM ユーザーに ApsaraVideo Live に対する読み取り専用権限を付与します。詳細については、「RAM ユーザーへの権限付与」をご参照ください。 -
API 呼び出しに使用するリージョン ID を取得します。ApsaraVideo Live で利用可能なリージョンの詳細については、「エンドポイント」をご参照ください。
説明--regionオプションを使用して、特定のリージョンでコマンドを実行できます。このオプションは、デフォルトの認証情報設定および環境変数内のリージョンを上書きします。詳細については、「API 呼び出しのコマンドラインオプション」をご参照ください。 -
RAM ユーザーの AccessKey ペアを使用して、
AkProfileという名前のプロファイルに AccessKey 認証情報を設定します。詳細については、「設定例」をご参照ください。
ステップ 3: CLI コマンドの生成
-
OpenAPI Explorer で、DescribeLiveUserDomains のデバッグページに移動します。
-
[パラメーター] タブでパラメーターを設定します。次に、[CLI サンプル] タブをクリックして、生成された CLI コマンドのサンプルを表示します。
-
CLI コマンドをコピーするか、 Cloud Shell で CLI コマンドをデバッグします。
-
アイコンをクリックして Cloud Shell を起動し、Cloud Shell で CLI コマンドをデバッグします。 -
アイコンをクリックして、CLI コマンドをクリップボードにコピーします。CLI コマンドをオンプレミスのシェルに貼り付けて、コマンドを実行することもできます。
説明CLI コマンドをローカルシェルに貼り付ける際は、パラメーター形式が要件に一致することを確認してください。詳細については、「パラメーター形式」をご参照ください。
OpenAPI Explorer は、デフォルトで生成された CLI コマンドに
--regionオプションを追加します。このオプションは、デフォルトの認証情報設定および環境変数内のリージョンを上書きします。デフォルトのリージョンを使用する場合は、このオプションを削除できます。 -
ステップ 4:ApsaraVideo Live の API オペレーションの呼び出し
例 1: Alibaba Cloud CLI による ApsaraVideo Live のサポート対象 API オペレーションの照会
--help オプションを実行して、 ApsaraVideo Live でサポートされているすべての API オペレーションを一覧表示します。サポートされている API オペレーションは、「機能別の操作一覧」で確認することもできます。
-
次のコマンドを実行します:
aliyun live --help -
コマンド出力を確認します。
Product: live (ApsaraVideo Live) Version: 2016-11-01 Available Api List: AddCasterComponent Adds a component to a caster. AddCasterEpisode Adds an episode to a caster. AddCasterEpisodeGroup Adds an episode group. AddCasterEpisodeGroupContent Adds content to an episode group. AddCasterLayout Adds a layout to a caster. AddCasterProgram Adds a program to a caster. AddCasterVideoResource Adds a video resource. The number of video resources is limited by the caster inputs. AddCustomLiveStreamTranscode Adds a custom transcoding configuration. AddLiveAIProduceRules AddLiveAISubtitle AddLiveAppRecordConfig Configures application-based recording and saves the output to OSS. AddLiveAppSnapshotConfig Configures snapshot capturing. The configuration takes effect after you restart streaming. AddLiveAudioAuditConfig Adds a configuration for audio moderation. AddLiveAudioAuditNotifyConfig Adds a callback configuration for audio moderation. AddLiveCenterTransfer Adds a stream relay configuration in Live Center. AddLiveDetectNotifyConfig Adds a callback URL for content moderation. AddLiveDomain Adds a domain name. You can add only one domain name at a time. AddLiveDomainMapping Adds a mapping between a streaming domain and an ingest domain. AddLiveDomainPlayMapping Adds a mapping between a primary streaming domain and a secondary streaming domain.
例 2: アカウント内の ApsaraVideo Live のすべてのドメイン名の照会
ApsaraVideo Live の DescribeUserDomains API を呼び出して、アカウント内のすべてのストリーミングドメイン名を照会します。
-
次のコマンドを実行します:
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 オペレーションを呼び出すときにエラーが返された場合は、エラーコードと照らし合わせて入力パラメーターと値を確認してください。
また、レスポンスまたは SDK のエラーメッセージから
RequestIdをコピーし、OpenAPI 診断プラットフォームを使用して、セルフサービス診断を行うこともできます。