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

Adiciona um programa a uma lista de reprodução.

Descrição da operação

Antes de chamar esta operação, crie um estúdio de produção no modo de lista de reprodução (NormType=6) e adicione recursos de vídeo a ele. Para criar um estúdio de produção usando uma operação de API, consulte CreateCaster.

Cada lista de reprodução pode conter até 1000 programas.

Importante

Ao usar recursos de vídeo sob demanda (VOD), utilize primeiro os recursos de Bucket gerenciado. Os recursos em seu próprio Bucket podem expirar. Se você usar recursos em seu próprio Bucket, verifique o período de validade do recurso.
Use recursos do ApsaraVideo Live e do ApsaraVideo VOD como entrada para o estúdio de produção. Recursos de URLs de terceiros podem falhar na reprodução. Verifique a qualidade e a validade desses recursos.

Limite de QPS

O limite de QPS por usuário para esta operação é de 10 chamadas por segundo. Se esse limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação adequadamente.

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:AddShowIntoShowList

create

*Caster.

acs:live:*:{#accountId}:caster/{#CasterId}

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
showList	array<object>	Não	A lista de recursos de programa a serem adicionados. Cada recurso possui parâmetros independentes, como showName e resourceUrl.
	object	Não	As informações da lista do estúdio de produção.
duration	integer	Não	A duração da reprodução de um único programa. Unidade: segundos. Nota Você pode definir apenas um entre repeatTimes e duration. Este parâmetro é obrigatório quando resourceType está definido como live.	20
liveInputType	integer	Não	A tag de tipo personalizado.	1
repeatTimes	integer	Não	O número de vezes que um único programa é repetido. Valor padrão: 0. Nota Você pode definir apenas um entre repeatTimes e duration. repeatTimes especifica o número de repetições. Por exemplo, 0 significa que o programa é repetido 0 vezes (reproduzido uma vez), 1 significa que o programa é repetido 1 vez (reproduzido duas vezes), e assim por diante.	0
resourceId	string	Não	O ID do arquivo VOD.	a2b8e671-2fe5-4642-a2ec-bf93880e****
resourceType	string	Não	O tipo de recurso. Valores válidos: live: recurso de transmissão ao vivo. vod: recurso de vídeo sob demanda. pic: recurso de imagem. Nota Ao usar recursos de vídeo sob demanda (VOD), utilize primeiro os recursos de Bucket gerenciado. Os recursos em seu próprio Bucket podem expirar. Se você usar recursos em seu próprio Bucket, verifique o período de validade do recurso. Arquivos ao vivo suportam recursos de transmissão ao vivo e URLs de terceiros. Arquivos VOD suportam recursos de vídeo sob demanda, recursos de imagem e URLs de terceiros. Ao usar recursos de transmissão ao vivo, você também deve especificar o parâmetro duration.	vod
resourceUrl	string	Não	A URL do arquivo de reprodução.	http://**/atestObject**.m3u8
showName	string	Não	O nome do programa.	liveShow****
CasterId	string	Sim	O ID do estúdio de produção. Se você criou o estúdio de produção chamando a operação CreateCaster, verifique o valor de CasterId retornado pela operação CreateCaster. Se você criou o estúdio de produção no console do ApsaraVideo Live, navegue até Console do ApsaraVideo Live > Estúdios de Produção > Estúdio de Produção em Nuvem para visualizar o nome do estúdio de produção. Nota O nome do estúdio de produção na lista de estúdios de produção na página Estúdio de Produção em Nuvem do console do ApsaraVideo Live é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
ShowName	string	Não	O nome do programa.	liveShow****
ResourceType	string	Não	O tipo de recurso. Valores válidos: live: recurso de transmissão ao vivo. vod: recurso de vídeo sob demanda. pic: recurso de imagem. Nota Ao usar recursos de vídeo sob demanda (VOD), utilize primeiro os recursos de Bucket gerenciado. Os recursos em seu próprio Bucket podem expirar. Se você usar recursos em seu próprio Bucket, verifique o período de validade do recurso. Arquivos ao vivo suportam recursos de transmissão ao vivo e URLs de terceiros. Arquivos VOD suportam recursos de vídeo sob demanda, recursos de imagem e URLs de terceiros. Ao usar recursos de transmissão ao vivo, você também deve especificar o parâmetro Duration.	vod
ResourceUrl	string	Não	A URL do arquivo de reprodução.	http://**/atestObject**.m3u8
ResourceId	string	Não	O ID do arquivo VOD.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Duration	integer	Não	A duração da reprodução de um único programa. Unidade: segundos. Nota Você pode definir apenas um entre RepeatTimes e Duration. Este parâmetro é obrigatório quando ResourceType está definido como live.	20
RepeatTimes	integer	Não	O número de vezes que um único programa é repetido. Valor padrão: 0. Nota Você pode definir apenas um entre RepeatTimes e Duration.- RepeatTimes especifica o número de repetições. Por exemplo, -1 significa repetição infinita, 0 significa que o programa é repetido 0 vezes (reproduzido uma vez), 1 significa que o programa é repetido 1 vez (reproduzido duas vezes), e assim por diante.	0
Spot	integer	Não	A posição na lista de reprodução onde o programa é inserido. As posições começam em 0. Por padrão, o programa é adicionado ao final da lista de reprodução atual.	1
LiveInputType	integer	Não	A tag de tipo personalizado.	1
isBatchMode	boolean	Não	Especifica se os programas devem ser adicionados à lista de reprodução em lote. Valores válidos: true: Adição em lote. false: Adição única. Nota Se este parâmetro não for especificado ou for deixado vazio, a adição única será usada.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	987DA143-A39C-5B5D-AF5B-3B07944A0036
ShowId	string	O ID do programa.	a2b8e671-2fe5-4642-a2ec-bf93880e****
failedList	string	A lista de recursos que falharam ao serem adicionados e os motivos da falha.	failedList[Show1, Show2...]
successfulShowIds	string	A lista de IDs de programas que foram adicionados com sucesso.	f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036",
  "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
  "failedList": "failedList[Show1, Show2...]",
  "successfulShowIds": "f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00"
}

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.	O userId especificado é inválido. Verifique o valor do parâmetro.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	O seguinte parâmetro é inválido: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	O parâmetro CasterId é inválido. Verifique o parâmetro e tente novamente.
400	InvalidVodUrl.Malformed	%s, please check and try again later.	O parâmetro VodUrl é inválido. Verifique e tente novamente.
400	MissingParameter	%s.	Um parâmetro obrigatório está ausente.
401	IllegalOperation	%s, please check and try again later.	A operação é inválida. Verifique a solicitação e tente novamente.
500	InternalError	%s, please try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
404	InvalidCaster.NotFound	%s, please check and try again later.	O estúdio de produção não existe. Verifique a configuração e tente novamente.
404	InvalidShowList.NotFound	%s, please check and try again later.	O ShowList não existe. Verifique e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.