Utiliser Alibaba Cloud CLI pour appeler les API OpenAPI d'ApsaraVideo Live - ApsaraVideo Live

Alibaba Cloud CLI est un outil en ligne de commande polyvalent basé sur OpenAPI. Il permet d'automatiser la gestion et la maintenance des ressources ApsaraVideo Live. Cette rubrique illustre l'utilisation d'Alibaba Cloud CLI avec ApsaraVideo Live en appelant l'opération DescribeLiveUserDomains pour interroger les noms de domaine de diffusion.

Prérequis

Familiarisez-vous avec Alibaba Cloud CLI. Pour plus d'informations, consultez la page Présentation d'Alibaba Cloud CLI.

Étape 1 : Installer Alibaba Cloud CLI

Installez Alibaba Cloud CLI sur votre appareil. Sélectionnez le package d'installation correspondant à votre système d'exploitation :

Système d'exploitation Windows : Windows
Système d'exploitation Linux : Linux
Système d'exploitation macOS : macOS

Vous pouvez également déboguer les commandes CLI dans Cloud Shell, qui intègre Alibaba Cloud CLI et le maintient à jour. Pour plus d'informations, consultez la page Présentation de Cloud Shell.

Étape 2 : Configurer Alibaba Cloud CLI

Important

Un compte Alibaba Cloud dispose d'un accès complet à toutes les API de service, ce qui présente des risques de sécurité. Nous vous recommandons de créer une identité Resource Access Management (RAM), d'accorder uniquement les autorisations requises selon le principe du moindre privilège, puis d'utiliser cette identité RAM pour appeler les opérations d'API. Pour plus d'informations sur les politiques prises en charge par ApsaraVideo Live, consultez les pages Politiques système d'ApsaraVideo Live et Politiques personnalisées d'ApsaraVideo Live.

Avant d'utiliser Alibaba Cloud CLI, configurez les identifiants et un ID de région. Alibaba Cloud CLI prend en charge divers types d'identifiants. Pour plus d'informations, consultez la section Types d'identifiants. Cet exemple utilise des paires AccessKey.

Créez un utilisateur RAM et générez une paire AccessKey pour cet utilisateur afin de configurer les identifiants. Pour plus d'informations, consultez les pages Créer un utilisateur RAM et Créer une paire AccessKey.
Accordez les autorisations nécessaires à l'utilisateur RAM. Dans cet exemple, attachez la politique AliyunLiveReadOnlyAccess à l'utilisateur RAM. Cette politique accorde à l'utilisateur RAM des autorisations en lecture seule sur ApsaraVideo Live. Pour plus d'informations, consultez la page Accorder des autorisations à un utilisateur RAM.
Obtenez l'ID de région pour vos appels d'API. Pour plus d'informations sur les régions disponibles pour ApsaraVideo Live, consultez la page Endpoints.

Remarque
Utilisez l'option --region pour exécuter une commande dans une région spécifique. Cette option remplace la région définie dans la configuration des identifiants par défaut et les variables d'environnement. Pour plus d'informations, consultez la page Options de ligne de commande pour les appels d'API.
Utilisez la paire AccessKey de l'utilisateur RAM pour configurer les identifiants AccessKey dans le profil nommé AkProfile. Pour plus d'informations, consultez la section Exemples de configuration.

Étape 3 : Générer une commande CLI

Dans OpenAPI Explorer, accédez à la page de débogage DescribeLiveUserDomains.
Dans l'onglet Parameters, configurez les paramètres. Cliquez ensuite sur l'onglet CLI Example pour afficher l'exemple de commande CLI généré.
Copiez la commande CLI ou déboguez-la dans Cloud Shell.
- Cliquez sur l'icône pour lancer Cloud Shell et déboguer la commande CLI dans Cloud Shell.
- Cliquez sur l'icône pour copier la commande CLI dans le presse-papiers. Vous pouvez également coller la commande CLI dans votre shell local pour l'exécuter.
Remarque
Lorsque vous collez la commande CLI dans votre shell local, assurez-vous que les formats des paramètres sont conformes aux exigences. Pour plus d'informations, consultez la page Formats des paramètres.

OpenAPI Explorer ajoute par défaut l'option --region à la commande CLI générée. Cette option remplace la région définie dans la configuration des identifiants par défaut et les variables d'environnement. Vous pouvez la supprimer si vous souhaitez utiliser la région par défaut.

Étape 4 : Appeler les opérations d'API d'**ApsaraVideo Live

Exemple 1 : Interroger les opérations d'API prises en charge par ApsaraVideo Live à l'aide d'Alibaba Cloud CLI

Exécutez l'option --help pour répertorier toutes les opérations d'API prises en charge par ApsaraVideo Live. Vous pouvez également consulter les opérations d'API prises en charge dans la page Liste des opérations par fonction.

Exécutez la commande suivante :
```
aliyun live --help
```

Consultez la sortie de la commande.

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.

Exemple 2 : Interroger tous les noms de domaine d'ApsaraVideo Live associés au compte

Appelez l'opération DescribeUserDomains d'ApsaraVideo Live pour interroger tous les noms de domaine de diffusion de votre compte.

Exécutez la commande suivante :

aliyun live DescribeLiveUserDomains --LiveDomainType liveVideo

Consultez la sortie de la commande.

{
  "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
}

Remarque

Si une erreur se produit lors de l'appel d'une opération d'API d'ApsaraVideo Live, vérifiez les paramètres d'entrée et les valeurs par rapport au code d'erreur.

Vous pouvez également copier le RequestId depuis la réponse ou le message d'erreur du SDK, puis utiliser la Plateforme de diagnostic OpenAPI pour effectuer un diagnostic en libre-service.