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

Consulta os dados de ingestão de fluxo na granularidade de aplicativo e fluxo para um nome de domínio especificado.

Descrição da operação

Somente um único nome de domínio pode ser consultado. Será retornado um erro se você especificar vários nomes de domínio.
Intervalo de tempo máximo de consulta por solicitação: 24 horas.
Granularidade mínima de consulta: 1 minuto.
Período máximo de consulta: 31 dias.
Esta é uma API de dados de monitoramento. O método de coleta e processamento de dados difere daquele usado para faturamento. Não use esta API para calcular o uso para reconciliação de faturamento.

Limite de QPS

O número máximo de consultas por segundo (QPS) por usuário para esta operação é 10. Se o número de chamadas por segundo exceder o limite, a limitação de taxa será acionada. Isso pode afetar seus negócios. Chame esta operação conforme apropriado.

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

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 nome de domínio acelerado a ser consultado. Somente um nome de domínio pode ser consultado por vez. Será retornado um erro se você especificar vários nomes de domínio. Se você não especificar AppName ou StreamName, os dados na granularidade de fluxo para todos os fluxos sob o nome de domínio acelerado especificado serão retornados sem agregação. Se DomainName for especificado e tanto AppName quanto StreamName estiverem definidos como all, os dados agregados na granularidade de fluxo para todos os fluxos sob o nome de domínio acelerado especificado serão retornados.	example.com
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no fuso horário UTC. Formato: YYYY-MM-DDThh:mm:ssZ.	2022-09-10T20:00:00Z
EndTime	string	Sim	O final do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no fuso horário UTC. O horário de término deve ser posterior ao horário de início, e a diferença não pode exceder 1 dia. Formato: YYYY-MM-DDThh:mm:ssZ.	2022-09-10T21:00:00Z
AppName	string	Não	O nome do aplicativo ao qual o fluxo ao vivo pertence. Especifique o nome do aplicativo para consultar dados na granularidade de fluxo para o aplicativo correspondente.	liveApp****
StreamName	string	Não	O nome do fluxo ao vivo. Se você especificar StreamName, os dados na granularidade de fluxo serão retornados para o StreamName especificado sob o AppName especificado. Você deve especificar AppName ao especificar StreamName.	liveStream****
NextPageToken	string	Não	O token de consulta de paginação. Cada consulta retorna no máximo 5.000 linhas de dados. Se os dados a serem consultados excederem 5.000 linhas, a resposta incluirá o índice inicial para a próxima consulta. Passe este token na solicitação para continuar consultando os dados a partir da linha após a última linha retornada na consulta anterior.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
DomainName	string	O nome de domínio acelerado.	example.com
EndTime	string	O final do intervalo de tempo para os dados retornados. O horário segue o padrão ISO 8601 no fuso horário UTC. Formato: YYYY-MM-DDThh:mm:ssZ.	2022-09-10T21:00:00Z
NextPageToken	string	O token de consulta de paginação. Cada consulta retorna no máximo 5.000 linhas de dados. Se os dados a serem consultados excederem 5.000 linhas, a resposta incluirá o índice inicial para a próxima consulta. Passe este token na solicitação para continuar consultando os dados a partir da linha após a última linha retornada na consulta anterior.	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	O número de linhas de dados retornadas.	5000
RequestId	string	O ID da solicitação.	5EBF2AC3-4B73-40A5-8B32-83F49D5F035E
StartTime	string	O início do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no fuso horário UTC. Formato: YYYY-MM-DDThh:mm:ssZ.	2022-09-10T20:00:00Z
StreamDetailData	object
StreamData	array<object>	As entradas de dados retornadas.
	object	As entradas de dados retornadas.
AppName	string	The application name.	liveApp****
ReqBps	number	The total bandwidth per minute for the stream. Unit: Bps.	133.33
ReqTraffic	integer	The total traffic per minute for the stream. Unit: bytes.	1000
StreamName	string	The stream name.	liveStream****
TimeStamp	string	The beginning of the time slice. The time follows the ISO 8601 standard in the UTC time zone. Format: YYYY-MM-DDThh:mm:ssZ.	2022-09-10T20:00:00Z

Exemplos

Resposta de sucesso

JSON formato

{
  "DomainName": "example.com",
  "EndTime": "2022-09-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "StartTime": "2022-09-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "liveApp****",
        "ReqBps": 133.33,
        "ReqTraffic": 1000,
        "StreamName": "liveStream****",
        "TimeStamp": "2022-09-10T20:00:00Z"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
400	InvalidPageToken	The token of page is invalid.	The specified paging token is incorrect. Specify the correct token returned by the last query and confirm that your request parameters are not modified.
400	InvalidAppName.Mismatch	The AppName param must be passed.	The AppName parameter does not match. Make sure that you specify the correct AppName.
400	InvalidStreamProtocol.NotSupport	The specified stream protocol is not support.
400	InvalidStreamName.LengthTooLong	The specified stream name is too long.
400	InvalidAppName.LengthTooLong	The specified app name is too long.
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	The specified time is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.