Use Alibaba Cloud CLI to call ApsaraVideo Live OpenAPI - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

A Alibaba Cloud CLI é uma ferramenta de linha de comando de uso geral baseada na OpenAPI. Com ela, você automatiza o gerenciamento e a manutenção dos recursos do ApsaraVideo Live. Este tópico demonstra como chamar a operação DescribeLiveUserDomains para consultar nomes de domínio de streaming, servindo como exemplo prático de uso da Alibaba Cloud CLI com o ApsaraVideo Live.

Antes de começar

Familiarize-se com a Alibaba Cloud CLI. Para mais informações, consulte What is Alibaba Cloud CLI?

Etapa 1: Instale a Alibaba Cloud CLI

Instale a Alibaba Cloud CLI no seu dispositivo. Selecione o pacote de instalação correspondente ao seu sistema operacional:

Sistema operacional Windows: Windows
Sistema operacional Linux: Linux
Sistema operacional macOS: macOS

Como alternativa, depure comandos da CLI diretamente no Cloud Shell, que já possui a Alibaba Cloud CLI integrada e sempre atualizada. Para mais informações, consulte What is Cloud Shell?.

Etapa 2: Configure a Alibaba Cloud CLI

Importante

Uma conta Alibaba Cloud tem acesso total a todas as APIs de service, o que representa riscos de segurança. Recomendamos criar uma identidade no Resource Access Management (RAM), conceder apenas as permissões necessárias com base no princípio do menor privilégio e usar essa identidade RAM para chamar operações de API. Para mais informações sobre as políticas compatíveis com o ApsaraVideo Live, consulte ApsaraVideo Live system policies e ApsaraVideo Live custom policies.

Antes de usar a Alibaba Cloud CLI, configure as credenciais de identidade e um ID de região. A Alibaba Cloud CLI oferece suporte a vários tipos de credenciais. Para mais informações, consulte Credential types. Este exemplo utiliza pares de AccessKey.

Crie um usuário RAM e gere um par de AccessKey para esse usuário, configurando assim as credenciais de identidade. Para mais informações, consulte Create a RAM user e Create an AccessKey pair.
Conceda as permissões necessárias ao usuário RAM. Neste exemplo, anexe a política AliyunLiveReadOnlyAccess ao usuário RAM. Essa política concede permissões somente leitura no ApsaraVideo Live. Para mais informações, consulte Grant permissions to a RAM user.
Obtenha o ID da região para suas chamadas de API. Para mais informações sobre as regiões disponíveis do ApsaraVideo Live, consulte Endpoints.

Nota
Use a opção --region para executar um comando em uma região específica. Essa opção substitui a região definida na configuração padrão de credenciais e nas variáveis de ambiente. Para mais informações, consulte Command line options for API calls.
Utilize o par de AccessKey do usuário RAM para configurar as credenciais de AccessKey no perfil chamado AkProfile. Para mais informações, consulte Configuration examples.

Etapa 3: Crie um comando da CLI

No OpenAPI Explorer, acesse a página de depuração DescribeLiveUserDomains.
Na aba Parameters, configure os parâmetros. Em seguida, clique em na aba CLI Example para visualizar o comando de exemplo gerado.
Copie o comando da CLI ou depure-o no Cloud Shell.
- Clique em no ícone para iniciar o Cloud Shell e depurar o comando diretamente nele.
- Clique em no ícone para copiar o comando da CLI para a área de transferência. Também é possível colar o comando no shell local para executá-lo.
Nota
Ao colar o comando da CLI no shell local, verifique se os formatos dos parâmetros atendem aos requisitos. Para mais informações, consulte Parameter formats.

O OpenAPI Explorer adiciona a opção --region ao comando gerado por padrão. Essa opção substitui a região definida na configuração padrão de credenciais e nas variáveis de ambiente. Remova-a caso prefira usar a região padrão.

Etapa 4: Chamar as operações de API do ApsaraVideo Live

Exemplo 1: Consultar as operações de API suportadas pelo ApsaraVideo Live usando a Alibaba Cloud CLI

Execute a opção --help para listar todas as operações de API suportadas pelo ApsaraVideo Live. Você também pode visualizar as operações disponíveis em List of operations by function.

Execute o seguinte comando:
```
aliyun live --help
```

Visualize a saída do comando.

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.

Exemplo 2: Consultar todos os nomes de domínio do ApsaraVideo Live na conta

Chame a operação DescribeUserDomains do ApsaraVideo Live para listar todos os nomes de domínio de streaming associados à sua conta.

Execute o seguinte comando:

aliyun live DescribeLiveUserDomains --LiveDomainType liveVideo

Visualize a saída do comando.

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

Nota

Se ocorrer um erro ao chamar uma operação de API do ApsaraVideo Live, verifique os parâmetros e valores de entrada com base no código de erro retornado.

Você também pode copiar o RequestId da resposta ou da mensagem de erro do SDK e utilizar a Plataforma de Diagnóstico da OpenAPI para realizar diagnósticos autônomos.