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

Edita uma playlist.

Descrição da operação

Esta operação realiza uma edição completa. Você pode usar esta operação para editar informações de configuração ou substituir vários itens da playlist.

Limite de QPS

O limite de consultas por segundo (QPS) para um único usuário é de 10 chamadas por segundo. Se você exceder esse limite, suas chamadas de API serão limitadas. Essa limitação pode afetar seus negócios. Chame esta API dentro do limite especificado.

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

update

*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
ProgramId	string	Sim	O ID da playlist. Se você adicionar itens à playlist chamando a operação AddPlaylistItems, use o valor de ProgramId retornado pela chamada.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItems	string	Sim	A lista de itens da playlist. Esta é 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**"}]
ProgramConfig	string	Não	A configuração da playlist. 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 playlist.
ResourceType	vod	String	O tipo de recurso. O único valor válido é vod, que indica um recurso de Vídeo sob Demanda (VOD).
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	O ID do recurso.

ProgramConfig

Parâmetro	Exemplo	Tipo	Descrição
RepeatNumber	0	Integer	O número de vezes para repetir a playlist após o término da reprodução. Valores válidos: 0 (padrão): A playlist não se repete. -1: A playlist é repetida indefinidamente. Qualquer outro número inteiro positivo: O número de vezes para repetir a playlist.
ProgramName	myprogram	String	O nome da playlist.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CasterId	string	O ID do estúdio de produção. Use este ID como parâmetro de solicitação para adicionar um callback ou um layout de estúdio virtual.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
Items	object	A lista de itens da playlist adicionados.
FailedItems	array<object>	A lista de itens da playlist que não puderam ser adicionados.
	object	A lista de itens da playlist que não puderam ser adicionados.
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item2
SuccessItems	array<object>	A lista de itens da playlist que foram adicionados com sucesso.
	object	A lista de itens adicionados com sucesso.
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item1
ProgramId	string	O ID da playlist. Use este ID como parâmetro de solicitação para excluir, consultar, iniciar ou parar a playlist.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	O ID da solicitação.	5c6a2a0d-f228-4a64-af62-20e91b96****

Exemplos

Resposta de sucesso

JSON formato

{
  "CasterId": "0e94d1f4-1a65-445c-9dcf-de8b3b8d****",
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ]
  },
  "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	InvalidProgramId.Malformed	%s, please check and try again later.	The parameter ProgramId is invalid, please check and try again.
400	PlayListIsEmpty	%s, please check and try again later.	Playlist is empty, please check and try again.
400	MissInputParams	%s, please check and try again later.	Parameter is missing, please check and try again.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	IncorrectPlaylistStatus.Inuse	%s, please check and try again later.	The Playlist is in use, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	PlayListNotFound	%s, please check and try again later.	PlayList does not exist, please check and try again.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station 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.