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

Consulta a lista de sessões de monitoramento criadas.

Descrição da operação

Primeiro, crie uma sessão de monitoramento. Em seguida, você pode chamar esta operação para consultar a lista de sessões de monitoramento. Ao chamar esta operação, certifique-se de que os parâmetros obrigatórios estejam configurados.

Limite de QPS

Esta operação é limitada a 15 consultas por segundo (QPS) para cada usuário. As chamadas de API que excederem esse limite serão limitadas. Isso pode afetar seus negócios. Planeje suas chamadas de acordo.

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

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
MonitorId	string	Não	O ID da sessão de monitoramento. Nota Obtenha o valor de MonitorId a partir dos parâmetros de resposta da operação CreateLiveStreamMonitor. Se você deixar este parâmetro vazio, os dados de todas as sessões de monitoramento serão retornados.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNum	integer	Não	O número da página.	2
PageSize	integer	Não	O número de sessões de monitoramento a serem retornadas em cada página.	10
Status	integer	Não	O status da sessão de monitoramento. Valores válidos: 1: A sessão está sendo monitorada. 0: A sessão não está sendo monitorada.	1
OrderRule	integer	Não	A ordem na qual classificar as sessões de monitoramento. Valores válidos: 0: Padrão. As sessões de monitoramento são classificadas por status de monitoramento em ordem decrescente (as sessões ativas são listadas primeiro). A hora de início não é usada para classificação. 1: As sessões de monitoramento são classificadas por hora de início em ordem decrescente. 2: As sessões de monitoramento são classificadas por hora de início em ordem crescente.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Total	integer	O número total de sessões de monitoramento.	1
RequestId	string	O ID da solicitação.	2234baba-a586-46ea-8bd4-c8f7891abcdef
LiveStreamMonitorList	array<object>	A lista de sessões de monitoramento.
	array<object>
MonitorConfig	string	As configurações para os limites de alerta de monitoramento. O valor é uma string JSON que inclui os seguintes campos: fpsLowThres: o limite de alerta para a taxa de quadros do vídeo. Este é um float. brHighThres: o limite de alerta para a taxa de bits de áudio e vídeo. Este é um float. eofDurationThresSec: o limite de alerta para a duração da interrupção do fluxo. Este é um float.	"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"
Status	integer	O status da sessão de monitoramento. Valores válidos: 1: A sessão está sendo monitorada. 0: A sessão não está sendo monitorada.	1
MonitorId	string	O ID da sessão de monitoramento.	445409ec-7eaa-461d-8f29-4bec2eb9****
Domain	string	O nome de domínio de saída para monitoramento.	demo.aliyundoc.com
CallbackUrl	string	O endereço do webhook para notificações de alerta de monitoramento.	http://guide.aliyundoc.com/notify
AudioFrom	integer	A fonte de áudio no layout.	1
DingTalkWebHookUrl	string	A URL do chatbot do DingTalk.	https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****
MonitorName	string	O nome da sessão de monitoramento.	liveMonito****
StopTime	string	A hora em que o monitoramento para. A hora está no formato UTC.	2017-01-11T12:00:00Z
StartTime	string	A hora em que o monitoramento começa. A hora está no formato UTC.	2017-01-11T12:00:00Z
OutputTemplate	string	O modelo para a resolução de saída. Valores válidos: lp_ld: baixa definição lp_sd: definição padrão lp_hd: alta definição lp_ud: ultra-alta definição	lp_ud
Region	string	A região. Valores válidos: cn-shanghai: China (Xangai) cn-beijing: China (Pequim) ap-southeast-1: Singapura	cn-shanghai
InputList	array<object>	A lista de fluxos de entrada para monitoramento.
	array<object>
Index	integer	The index. This parameter is used by the frontend.	1
InputUrl	string	The URL of the input stream.	demo.aliyundoc.com
LayoutId	integer	The layout ID. The value must start from 1.	1
StreamName	string	The display name of the stream for monitoring.	monitorStream****
LayoutConfig	object	The layout information.
FillMode	string	The fill mode. For frontend development, set this parameter to none.	none
PositionRefer	string	The reference point for the element's position. Valid values: topLeft topRight bottomLeft bottomRight	topLeft
PositionNormalized	array	The normalized coordinates of the element's position, in the format of [x,y]. The default value is [0,0]. The values of x and y must be normalized.
	number	The position of the element's fill area, in the format of [x,y]. The values of x and y are normalized percentages. For example, [0.1,0.1] indicates a horizontal offset of 10% and a vertical offset of 10% from the top-left corner.	0.1
SizeNormalized	array	The normalized size of the element's fill area, in the format of [w,h].
	number	The size of the element's fill area, in the format of [w,h]. The values of w and h are normalized percentages. For example, [0.2,0.3] indicates a horizontal proportion of 20% and a vertical proportion of 30%.	0.3
PlayConfig	object	The playback configuration.
VolumeRate	number	The volume. The value must be between 0 and 1, inclusive, with up to two decimal places.	0.50
OutputUrls	object	As URLs de saída para monitoramento.
FlvUrl	string	The output URL in FLV format.	http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv
RtmpUrl	string	The output URL in RTMP format.	rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****

Exemplos

Resposta de sucesso

JSON formato

{
  "Total": 1,
  "RequestId": "2234baba-a586-46ea-8bd4-c8f7891abcdef",
  "LiveStreamMonitorList": [
    {
      "MonitorConfig": "\"{\\\"fpsLowThres\\\": 0.6,\\\"brLowThres\\\": 1.1,\\\"eofDurationThresSec\\\": 10}\"",
      "Status": 1,
      "MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "Domain": "demo.aliyundoc.com",
      "CallbackUrl": "http://guide.aliyundoc.com/notify",
      "AudioFrom": 1,
      "DingTalkWebHookUrl": "https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****",
      "MonitorName": "liveMonito****",
      "StopTime": "2017-01-11T12:00:00Z",
      "StartTime": "2017-01-11T12:00:00Z",
      "OutputTemplate": "lp_ud",
      "Region": "cn-shanghai",
      "InputList": [
        {
          "Index": 1,
          "InputUrl": "demo.aliyundoc.com",
          "LayoutId": 1,
          "StreamName": "monitorStream****",
          "LayoutConfig": {
            "FillMode": "none",
            "PositionRefer": "topLeft",
            "PositionNormalized": [
              0.1
            ],
            "SizeNormalized": [
              0.3
            ]
          },
          "PlayConfig": {
            "VolumeRate": 0.5
          }
        }
      ],
      "OutputUrls": {
        "FlvUrl": "http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv",
        "RtmpUrl": "rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****"
      }
    }
  ]
}

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.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.