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

Consulta os registros de callback de stream.

Descrição da operação

O limite de QPS para um único usuário desta operação de API é 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 com uma frequência apropriada.

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

get

*Domain

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

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.	push.example1.com
AppName	string	Não	O nome da aplicação à qual o stream ao vivo pertence. Você pode visualizar o AppName na página Stream Management.	app
StreamName	string	Não	O nome do stream ao vivo. Você pode visualizar o StreamName na página Stream Management.	stream
Status	string	Não	Especifica se o callback foi bem-sucedido. Valores válidos: success: Bem-sucedido. failed: Falhou. Valores válidos: success : Bem-sucedido. failed : Falhou.	success
StartTime	string	Sim	A hora de início. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC). Nota A hora de início deve estar nos últimos 7 dias.	2017-12-10T08:00:00Z
EndTime	string	Sim	A hora de término. A hora de término deve ser posterior à hora de início. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-10T09:00:00Z
PageSize	integer	Não	O tamanho da página. Valor padrão: 20. Valor máximo: 500. Valores válidos: qualquer número inteiro de 1 a 500.	20
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os registros de callback de stream ingest.
NotifyRecordsInfo	object
LiveStreamNotifyRecordsInfo	array<object>	Os registros de callback de stream ingest.
	object
NotifyType	string	The callback type. Valid values: publish: a stream ingest event. publish_done: a stream disconnection event.	publish_done
Description	string	The result description. The value is success if the callback is successful. Otherwise, an error message is returned.	success
StreamName	string	The name of the live stream.	stream
NotifyTime	string	The time when the callback occurred (UTC).	2022-10-19T19:09:28Z
DomainName	string	The ingest domain.	push.example1.com
NotifyContent	string	The specific content of the callback.	{\"action\":\"publish_done\",\"app\":\"push.example1.com\"}
NotifyUrl	string	The callback URL.	http://xx.xx.xx.xx/callbacks
NotifyResult	string	The callback result. Valid values: success: Successful. failed: Failed.	success
AppName	string	The name of the application to which the live stream belongs.	app
NotifyResponse	string	The response returned by the user after receiving the callback.	{"Code":0,"Msg":"Success"}
NotifyHeader	string	The request header of the callback request.	Host: 123456.cn-shanghai.example1.com User-Agent: Go-http-client/1.1 Accept-Encoding: gzip
PageNum	integer	O número da página.	1
PageSize	integer	O tamanho da página.	20
RequestId	string	O ID da solicitação.	F675E4B4-125D-1533-901B-11A724644285
TotalNum	integer	O número total de entradas que correspondem às condições especificadas.	20
TotalPage	integer	O número total de páginas.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "NotifyRecordsInfo": {
    "LiveStreamNotifyRecordsInfo": [
      {
        "NotifyType": "publish_done",
        "Description": "success",
        "StreamName": "stream",
        "NotifyTime": "2022-10-19T19:09:28Z",
        "DomainName": "push.example1.com",
        "NotifyContent": "{\\\"action\\\":\\\"publish_done\\\",\\\"app\\\":\\\"push.example1.com\\\"}",
        "NotifyUrl": "http://xx.xx.xx.xx/callbacks",
        "NotifyResult": "success",
        "AppName": "app",
        "NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
        "NotifyHeader": "Host: 123456.cn-shanghai.example1.com\nUser-Agent: Go-http-client/1.1\nAccept-Encoding: gzip"
      }
    ]
  },
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "F675E4B4-125D-1533-901B-11A724644285",
  "TotalNum": 20,
  "TotalPage": 20
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.
400	Duration.Exceed	StartTime needs to be within the last 7 days.
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.