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

Descrição da operação

Crie um estúdio de produção, adicione um layout e componentes do estúdio de produção e, em seguida, chame esta operação para adicionar um item à lista de reprodução. Se nenhuma lista de reprodução tiver sido criada, o sistema criará uma automaticamente. Para criar um estúdio de produção usando uma operação de API, consulte CreateCaster.

Limite de QPS

O limite de QPS por usuário para esta operação é de 10 chamadas por segundo. Se o limite for excedido, a chamada da API será limitada, 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:AddPlaylistItems

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
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 do parâmetro 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. O estúdio de produção deve atender às seguintes configurações: NormType: 3. Crie previamente um estúdio de produção de carrossel leve. Você pode chamar a operação CreateCaster para criar um estúdio de produção. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect: 1.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	Sim	A lista de entradas de itens da lista de reprodução. O valor é uma string JSON. Para mais informações, consulte InputProgramItem.	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramId	string	Não	O ID da lista de reprodução. Se o estúdio de produção já possuir uma lista de reprodução, você deve especificar o ProgramId correspondente. Se nenhuma lista de reprodução tiver sido criada, você pode deixar este parâmetro vazio e o sistema realizará a criação automática.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	Não	A configuração do item da lista de reprodução. Se esta for a primeira vez que você adiciona um item à lista de reprodução, especifique este parâmetro para inicialização. Para mais informações, consulte ProgramConfig.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parâmetro	Exemplo	Tipo	Descrição
ItemName	item1	String	O nome do item da lista de reprodução.
ResourceType	vod	String	O tipo de recurso. Valores válidos: vod: Recurso do ApsaraVideo VOD. url: Recurso de vídeo de terceiros.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	Quando ResourceType está definido como vod, ResourceValue é o ID do ativo de mídia. Quando ResourceType está definido como url, ResourceValue é a URL do vídeo de terceiros.

ProgramConfig

Parâmetro	Exemplo	Tipo	Descrição
RepeatNumber	0	Integer	O número de vezes para repetir a reprodução após o término da lista de reprodução. Valores válidos: 0 (padrão): sem repetição de reprodução. -1: repetir indefinidamente. Outros inteiros positivos: o número de vezes para repetir a reprodução após o término da lista de reprodução.
ProgramName	myprogram	String	O nome da lista de reprodução.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Items	object	A lista de itens adicionados à lista de reprodução.
FailedItems	array<object>	A lista de itens da lista de reprodução que falharam ao serem adicionados.
	object
ItemId	string	O ID do item da lista de reprodução.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	O nome do item da lista de reprodução.	item1
SuccessItems	array<object>	A lista de itens da lista de reprodução que foram adicionados com sucesso.
	object
ItemId	string	O ID do item da lista de reprodução.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	O nome do item da lista de reprodução.	item2
ProgramId	string	O ID da lista de reprodução. Este valor pode ser usado como parâmetro de solicitação para excluir itens da lista de reprodução, consultar itens da lista de reprodução, editar listas de reprodução, excluir listas de reprodução, consultar listas de reprodução, iniciar listas de reprodução e parar listas de reprodução.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	O ID da solicitação.	5c6a2a0d-f228-4a64-af62-20e91b96****

Exemplos

Resposta de sucesso

JSON formato

{
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidCasterId.Malformed	%s, please check and try again later.	O parâmetro CasterId é inválido. Verifique o parâmetro e tente novamente.
400	PlayListIsEmpty	%s, please check and try again later.	A playlist está vazia. Verifique a playlist e tente novamente.
400	MissInputParams	%s, please check and try again later.	Parâmetros obrigatórios estão ausentes. Verifique e tente novamente.
400	InvalidProgramId.Malformed	%s, please check and try again later.	O parâmetro ProgramId é inválido. Verifique o parâmetro e tente novamente.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	O seguinte parâmetro é inválido: %s.
500	InternalError	%s, please try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
403	UserQuotaExceed	Quota exceeded: %s.	A cota foi excedida: %s.
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	InvalidDomainName.NotFound	%s, please check and try again later.	O nome de domínio não existe. Verifique o nome de domínio 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.