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

Descrição da operação

Antes de chamar esta operação, certifique-se de compreender totalmente o método de cobrança e os preços dos snapshots de live stream no ApsaraVideo Live. Para mais informações, consulte Cobrança de snapshots de live stream.
Certifique-se de que o Object Storage Service (OSS) esteja ativado e um bucket específico tenha sido criado. Dessa forma, o ApsaraVideo Live pode armazenar snapshots de live stream no bucket. Para mais informações, consulte Configurar o OSS.
Se você armazenar snapshots no OSS, serão geradas taxas de armazenamento. Para mais informações, consulte Taxas de armazenamento.
O bucket do OSS deve residir na mesma região do centro de live do domínio de streaming. A captura de snapshot entre regiões não é suportada.

Limite de QPS

Você pode chamar esta operação até 30 vezes por segundo por conta. As solicitações que excederem esse limite serão descartadas e você sofrerá interrupções no serviço. Recomendamos que você observe esse limite ao chamar esta operação.

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

create

*Domain

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Sim	O domínio principal de streaming.	example.com
AppName	string	Sim	O nome do aplicativo ao qual o live stream pertence. O valor deste parâmetro deve ser igual ao nome do aplicativo na URL de ingestão. Caso contrário, a configuração não entrará em vigor. O nome pode ter até 255 caracteres e pode conter dígitos, letras, hifens (-) e sublinhados (_). O nome não pode começar com um hífen (-) ou sublinhado (_). Você também pode especificar um asterisco (*) como valor para corresponder a todos os aplicativos.	liveApp****
TimeInterval	integer	Sim	O intervalo no qual os snapshots são capturados. Unidade: segundos. Valores válidos: 5 a 3600.	5
OssEndpoint	string	Sim	O endpoint do bucket do OSS. Após a conclusão da configuração, você pode pesquisar snapshots específicos no console do OSS com base nas informações de callback. Você deve configurar o endpoint do OSS antecipadamente. Para mais informações, consulte Configurar o OSS.	cn-oss-****.aliyuncs.com
OssBucket	string	Sim	O nome do bucket do OSS. Após a conclusão da configuração, você pode pesquisar snapshots específicos no console do OSS com base nas informações de callback. Você deve criar o bucket do OSS antecipadamente. Para mais informações, consulte Configurar o OSS.	liveBucket****
OverwriteOssObject	string	Não	O formato de nomenclatura dos snapshots armazenados no modo de sobrescrita, o que significa que um novo snapshot sobrescreve o snapshot anterior. O nome deve ter menos de 256 bytes de comprimento. Apenas imagens JPG são suportadas. O nome pode conter variáveis como {AppName} e {StreamName}.	{AppName}/{StreamName}.jpg
SequenceOssObject	string	Não	O formato de nomenclatura dos snapshots armazenados em sequência, o que significa que um novo snapshot não sobrescreve o snapshot anterior. Você pode chamar a operação DescribeLiveStreamSnapshotInfo para consultar os snapshots que foram capturados dentro de um período de tempo específico. O nome deve ter menos de 256 bytes de comprimento. Apenas imagens JPG são suportadas. O nome pode conter variáveis como {AppName}, {StreamName}, {UnixTimestamp} e {Sequence}. O nome deve conter pelo menos uma das variáveis {UnixTimestamp} e {Sequence}.	snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
Callback	string	Não	A URL de callback usada para receber notificações sobre a captura de snapshot.	https://learn.aliyundoc.com

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidOverwriteOssObjectOrSequenceOssObject.Malformed	Specified paramters OverwriteOssObject or SequenceOssObject should have one.	You can specify only one of the OverwriteOssObject and SequenceOssObject parameters.
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.
400	InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is not valid.
400	InvalidOverwriteOssObject.Malformed	Specified parameter OverwriteOssObject is not valid.
400	InvalidSequenceOssObject.Malformed	Specified parameter SequenceOssObject is not valid.	Invalid value of SequenceOssObject. Check whether the SequenceOssObject parameter that you specified is correct.
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.
400	ConfigAlreadyExists	Config has already exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.