使用阿里雲CLI調用ApsaraVideo for LiveOpenAPI - ApsaraVideo Live

阿里雲CLI（Alibaba Cloud Command Line Interface）是基於OpenAPI構建的通用命令列工具，您可以通過阿里雲CLI實現自動化管理和維護ApsaraVideo Live。本文以調用DescribeLiveUserDomains介面查詢使用者名稱下播流網域名稱為例，為您介紹使用阿里雲CLI調用ApsaraVideo LiveOpenAPI的操作步驟。

前置概念

閱讀本文前，若您還不瞭解阿里雲CLI，請參見什麼是阿里雲 CLI。

步驟一：安裝阿里雲CLI

使用阿里雲CLI前，您需要先安裝阿里雲CLI。阿里雲CLI為使用者提供了Windows、Linux和macOS三種作業系統下的安裝服務，請根據您使用裝置的作業系統選擇對應的安裝服務。

您也可在Cloud Shell中調試阿里雲CLI命令。Cloud Shell中預裝了阿里雲CLI，且會定期更新軟體版本。更多資訊，請參見什麼是雲命令列。

步驟二：配置阿里雲CLI

重要

阿里雲主帳號擁有所有產品OpenAPI的管理和存取權限，風險很高。強烈建議您建立RAM身份，並依據最小化許可權原則授予許可權，使用RAM身份訪問OpenAPI。ApsaraVideo Live支援的權限原則，請參見ApsaraVideo for Live系統權限原則參考及ApsaraVideo for Live自訂權限原則參考。

使用阿里雲CLI之前，您需要在阿里雲CLI中配置身份憑證、地區ID等資訊。阿里雲CLI支援多種身份憑證，詳情請參見配置與管理身份憑證。本文操作以AK類型憑證為例，具體操作步驟如下：

建立一個RAM使用者，並建立AccessKey，以便後續配置身份憑證使用。具體操作，請參見建立RAM使用者及建立AccessKey。
為RAM使用者授權。本文樣本需授予RAM使用者唯讀訪問ApsaraVideo Live的許可權AliyunLiveReadOnlyAccess。具體操作，請參見管理RAM使用者的許可權。
擷取可用的地區ID，以便後續配置身份憑證使用。阿里雲CLI將使用您指定的地區發起OpenAPI調用，ApsaraVideo Live的可用地區請參見服務存取點。

說明
使用阿里雲CLI過程中您可使用--region選項指定地區發起命令調用，該選項在使用時將忽略預設身份憑證配置及環境變數設定中的地區資訊。詳情請參見命令列選項。
使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置與管理身份憑證。

步驟三：產生CLI命令樣本

在OpenAPI門戶中，訪問DescribeLiveUserDomains調試地址。
在參數配置中輸入請求參數，單擊CLI樣本頁簽，查看產生的CLI樣本。
複製CLI樣本或在Cloud Shell中快速執行：
- 單擊運行命令按鈕，可喚出Cloud Shell並快速完成命令調試。
- 單擊複製按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行。
說明
複製CLI樣本到本地Shell工具中進行調試時請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見理解命令列參數。

OpenAPI門戶產生樣本中會預設添加--region選項，複製命令到本地調用時阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。

步驟四：調用ApsaraVideo LiveOpenAPI

樣本一：擷取支援阿里雲CLI調用的ApsaraVideo LiveOpenAPI列表

以下樣本將為您展示如何使用--help選項擷取支援阿里雲CLI調用的ApsaraVideo LiveOpenAPI列表。您也可在API概覽中查看支援調用的OpenAPI。

執行命令。
```
aliyun live --help
```

輸出結果。

Product: live (ApsaraVideo for Live)
Version: 2016-11-01
Available Api List:
    AddCasterComponent            調用AddCasterComponent添加導播台組件。
    AddCasterEpisode              調用AddCasterEpisode添加導播台節目。
    AddCasterEpisodeGroup         調用AddCasterEpisodeGroup添加導播台節目列表。
    AddCasterEpisodeGroupContent  調用AddCasterEpisodeGroupContent添加導播台節目列表資訊。
    AddCasterLayout               調用AddCasterLayout添加導播檯布局。
    AddCasterProgram              調用AddCasterProgram添加導播台節目單。
    AddCasterVideoResource        添加視頻源，視頻源數量受限於導播台輸入路數。
    AddCustomLiveStreamTranscode  調用AddCustomLiveStreamTranscode添加自訂轉碼配置資訊。
    AddLiveAIProduceRules
    AddLiveAISubtitle
    AddLiveAppRecordConfig        配置APP錄製，輸出內容儲存到OSS中。
    AddLiveAppSnapshotConfig      配置截圖資訊。輸出內容儲存到OSS中，重新推流即生效。
    AddLiveAudioAuditConfig       調用AddLiveAudioAuditConfig添加直播語音審核配置資訊。
    AddLiveAudioAuditNotifyConfig 調用AddLiveAudioAuditNotifyConfig添加音頻審核回調資訊。
    AddLiveCenterTransfer         調用AddLiveCenterTransfer添加直播中心轉推配置。
    AddLiveDetectNotifyConfig     添加直播審核回調通知地址
    AddLiveDomain                 一次只能提交一個網域名稱。
    AddLiveDomainMapping          添加直播網域名稱播流網域名稱和推流網域名稱的映射關係配置。
    AddLiveDomainPlayMapping      添加主播流網域名稱和子播流網域名稱映射。

樣本二：查詢使用者名稱下所有的播流網域名稱

以下樣本將為您展示如何使用阿里雲CLI調用ApsaraVideo Live的DescribeLiveUserDomains命令，查詢使用者名稱下所有的播流網域名稱。

執行命令。

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 LiveOpenAPI後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。

您也可以記錄下調用返回的RequestID或SDK報錯資訊，通過阿里雲OpenAPI診斷平台進行自助診斷。