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

Consulta as configurações de snapshot sob um domínio de streaming.

Descrição da operação

Obtenha o domínio de streaming primeiro e, em seguida, chame esta operação para consultar as configurações de snapshot sob o domínio de streaming.

Limite de QPS

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

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Sim	O domínio de streaming.	example.com
AppName	string	Não	O nome da aplicação à qual o live stream pertence.	liveApp****
PageNum	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 5 a 30. Valor padrão: 10.	10
Order	string	Não	A ordem de classificação. Valores válidos: asc (padrão): ordem crescente. desc: ordem decrescente. Valores válidos: asc : Ordem crescente. desc : Ordem decrescente.	asc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNum	integer	O número da página.	2
RequestId	string	O ID da solicitação.	A3136B58-5876-4168-83CA-B562781981A0
Order	string	A ordem de classificação.	asc
TotalPage	integer	O número total de páginas.	10
PageSize	integer	O número de entradas por página.	11
TotalNum	integer	O número total de entradas que atendem às condições especificadas.	6
LiveStreamSnapshotConfigList	object
LiveStreamSnapshotConfig	array<object>	A lista de configurações de snapshot.
	object
OverwriteOssObject	string	The name of the file that stores overwritten snapshots.	{liveApp**}/{liveStream**}.jpg
TimeInterval	integer	The snapshot interval. Unit: seconds.	10
AppName	string	The name of the application to which the live stream belongs.	liveApp****
CreateTime	string	The time when the configuration was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-05-20T01:33:38Z
OssBucket	string	The name of the OSS bucket.	liveBucket****
DomainName	string	The streaming domain.	example.com
Callback	string	The snapshot callback URL.	https://learn.aliyundoc.com
SequenceOssObject	string	The name of the file that stores real-time snapshots.	snapshot/{liveApp**}/{liveStream**}/{UnixTimestamp}.jpg
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNum": 2,
  "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
  "Order": "asc",
  "TotalPage": 10,
  "PageSize": 11,
  "TotalNum": 6,
  "LiveStreamSnapshotConfigList": {
    "LiveStreamSnapshotConfig": [
      {
        "OverwriteOssObject": "{liveApp****}/{liveStream****}.jpg",
        "TimeInterval": 10,
        "AppName": "liveApp****",
        "CreateTime": "2016-05-20T01:33:38Z",
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "Callback": "https://learn.aliyundoc.com",
        "SequenceOssObject": "snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg",
        "OssEndpoint": "cn-oss-****.aliyuncs.com"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.