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

Descrição da operação

Crie um estúdio de produção no modo de lista de reprodução antes de chamar esta operação para adicionar materiais de plano de fundo. Para criar um estúdio de produção usando uma operação de API, consulte CreateCaster.
Você pode usar esta operação para criar, atualizar ou excluir um plano de fundo de lista de reprodução. Para excluir o plano de fundo, deixe os parâmetros ResourceType, ResourceUrl e MaterialId vazios.

null

Ao usar recursos do ApsaraVideo VOD, use 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 de material prioritariamente. 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 o limite for excedido, a chamada de API será limitada, o que pode afetar o seu negócio. 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:SetShowListBackground

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
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. null 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 é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
ResourceType	string	Não	O tipo de material. Valores válidos: LIVE: material de transmissão ao vivo. Suporta materiais de transmissão ao vivo e URLs de terceiros. VOD: material de vídeo sob demanda. Suporta materiais de vídeo sob demanda e URLs de terceiros. PIC: material de imagem. Suporta materiais de vídeo sob demanda e URLs de terceiros. null Especifique um dos três valores ou deixe este parâmetro vazio. Valores válidos: VOD : material de vídeo sob demanda. PIC : material de imagem. LIVE : material de transmissão ao vivo.	VOD
MaterialId	string	Não	O ID do material de vídeo sob demanda. null Especifique este parâmetro ou ResourceUrl.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceUrl	string	Não	A URL do material externo.	http://**/atestObject**.m3u8

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	987DA143-A39C-5B5D-AF5B-3B07944A0036

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}

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	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.Status	%s, please check and try again.	Status is invalid, please check and try again.
400	InvalidParameter.StartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
400	InvalidParameter.EndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	The caster does not exist.	The caster does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.