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

Descrição da operação

Após obter um nome de domínio de transmissão ao vivo, você pode chamar esta operação para consultar o status em tempo real de um único stream. Para obter detalhes sobre o status offline, use os dados retornados pelo callback de ingestão de stream. Esta operação não fornece um detalhamento do status offline.

Limites de QPS

Você pode chamar esta operação até 100 vezes por segundo por conta. As solicitações que excederem esse limite serão descartadas e você poderá sofrer interrupções no serviç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:DescribeLiveStreamState

get

*All Resource

*

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
DomainName	string	Sim	O domínio de ingestão ou o domínio de streaming.	demo.aliyundoc.com
AppName	string	Sim	O AppName do stream ao vivo. Visualize os AppNames na página Gerenciamento de Streams.	liveApp****
StreamName	string	Sim	O nome do stream ao vivo. Visualize os StreamNames na página Gerenciamento de Streams.	liveStream****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Type	string	O método de ingestão de stream. Valores válidos: push pull	push
RequestId	string	O ID da solicitação.	CE6CD79D-0A98-1F22-A15F-FADA74DF2729
StreamState	string	O estado do stream. Valores válidos: online: O stream está ativo. offline: O stream está offline. Isso pode significar que a ingestão do stream falhou ou foi encerrada. Para detalhes específicos, use os dados retornados pelo callback de ingestão de stream. Esta operação não fornece um detalhamento completo do status offline.	online

Exemplos

Resposta de sucesso

JSON formato

{
  "Type": "push",
  "RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729",
  "StreamState": "online"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.