DescribeShowList - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Consulta uma playlist.

Descrição da operação

Antes de chamar esta operação, você deve adicionar um programa à playlist. Para adicionar um programa chamando uma operação de API, consulte Adicionar um programa a uma playlist.

Limite de QPS

O limite de consultas por segundo (QPS) para um único usuário é 10. Se o limite for excedido, as chamadas de API serão limitadas. Isso pode afetar suas operações comerciais. Planeje suas chamadas de acordo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

live:DescribeShowList

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-shanghai
CasterId	string	Sim	O ID do estúdio de produção. Se você criar um estúdio de produção chamando a operação CreateCaster, use o valor CasterId retornado na resposta. Se você criar um estúdio de produção no console LIVE, escolha Console LIVE > Estúdio de Produção > Estúdio de Produção em Nuvem para encontrar o nome do estúdio de produção. Nota O nome do estúdio de produção na lista da página Estúdio de Produção em Nuvem é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
ShowList	string	Os detalhes da playlist. Show contém os detalhes de um programa na playlist.	ShowList[Show1, Show2, Show3...]
ShowListInfo	object	A playlist.
CurrentShowId	string	O ID do programa que está sendo reproduzido.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Background	string	O plano de fundo da playlist.	{\"MaterialId\":\"a2b8e671-2fe5-4642-a2ec-bf93880e****\",\"resourceType\":\"VOD\"}
HighPriorityShowId	string	O programa de maior prioridade. Nota Você pode configurar este parâmetro apenas antes do início da playlist.	a2b8e671-2fe5-4642-a2ec-bf93880e****
HighPriorityShowStartTime	string	A hora em que o programa de maior prioridade é reproduzido. O formato é yyyy-MM-dd'T'HH:mm:ss. Nota Você pode configurar este parâmetro apenas antes do início da playlist. Após a conclusão da configuração, o sistema alterna para o programa de maior prioridade no horário especificado.	2021-11-23T12:30:00
ShowList	object
Show	array<object>	The list of shows in the playlist.
	array<object>	The details of the show.
Duration	integer	The duration of a single show, in seconds.	20
RepeatTimes	integer	The number of times a single show is looped. For example, a value of 0 indicates that the show is played once. A value of 1 indicates that the show is played twice.	5
ResourceInfo	object	The resource information.
LiveInputType	integer	The custom type identifier.	1
ResourceId	string	The ID of the video-on-demand (VOD) file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceType	string	The type of the resource material.	vod
ResourceUrl	string	The URL of the resource.	http:///atestObject.m3u8
ShowId	string	The ID of the show.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ShowName	string	The name of the show.	liveShow****
ShowListRepeatTimes	integer	O número padrão de loops para a playlist. Este valor é sempre 0.	0
TotalShowListRepeatTimes	integer	O número de vezes que toda a playlist é repetida em loop.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ShowList": "ShowList[Show1, Show2, Show3...]",
  "ShowListInfo": {
    "CurrentShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "Background": "{\\\"MaterialId\\\":\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\",\\\"resourceType\\\":\\\"VOD\\\"}",
    "HighPriorityShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
    "HighPriorityShowStartTime": "2021-11-23T12:30:00",
    "ShowList": {
      "Show": [
        {
          "Duration": 20,
          "RepeatTimes": 5,
          "ResourceInfo": {
            "LiveInputType": 1,
            "ResourceId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
            "ResourceType": "vod",
            "ResourceUrl": "http://**/atestObject**.m3u8"
          },
          "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
          "ShowName": "liveShow****"
        }
      ]
    },
    "ShowListRepeatTimes": 0,
    "TotalShowListRepeatTimes": 1
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidShowList.NotFound	%s, please check and try again later.	ShowList does not exist, please check and try again.
404	InvalidShow.NotFound	%s, please check and try again later.	Show does not exist, please check and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.