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

Consulta os dados de monitoramento de largura de banda de rede de um domínio de transmissão ao vivo.

Descrição da operação

Se você não especificar StartTime ou EndTime, os dados das últimas 24 horas serão retornados por padrão. Você também pode consultar dados de um intervalo de tempo específico especificando StartTime e EndTime.
Se você especificar apenas StartTime sem EndTime, os dados dentro de 1 hora a partir de StartTime serão retornados.
Se você especificar apenas EndTime sem StartTime, os dados dentro de 1 hora antes de EndTime serão retornados.
Você pode consultar dados de até os últimos 90 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 limite de QPS por usuário para esta API é de 100 chamadas por segundo. Se esse limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta API em uma frequência razoável.

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

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	Não	O domínio de transmissão. Você pode especificar um único nome de domínio ou vários nomes de domínio. Separe vários nomes de domínio com vírgulas (,). Se este parâmetro for deixado vazio, os dados mesclados de todos os domínios de transmissão ao vivo serão retornados por padrão.	example.com
StartTime	string	Não	A hora de início. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-10T08:00:00Z
EndTime	string	Não	A hora de término. A hora de término deve ser posterior à hora de início. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-10T09:00:00Z
Interval	string	Não	A granularidade de tempo dos dados consultados. Unidade: segundos. Valores válidos: 300 (padrão) 3600 86400 Nota Se este parâmetro não for especificado ou for definido com um valor não suportado, o valor padrão 300 será usado. Quando a granularidade de tempo for 300, o valor de bps retornado é a média de bits transmitidos por segundo dentro do intervalo de 300 segundos. Quando a granularidade de tempo for 3600 ou 86400, o valor de bps retornado é o valor de pico entre todos os pontos de dados de 300 segundos dentro do período de consulta.	300
IspNameEn	string	Não	O nome do provedor de serviços de Internet (ISP) em inglês. Você pode chamar a operação DescribeCdnRegionAndIsp para obter o nome do ISP.	alibaba
LocationNameEn	string	Não	O nome da região em inglês. Você pode chamar a operação DescribeCdnRegionAndIsp para obter o nome da região.	tianjin

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	A hora de término. A hora está no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-10T09:00:00Z
StartTime	string	A hora de início. A hora está no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-10T08:00:00Z
RequestId	string	O ID da solicitação.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	O domínio de transmissão.	example.com
DataInterval	string	A granularidade de tempo dos dados consultados. Unidade: segundos.	300
BpsDataPerInterval	object
DataModule	array<object>	Os dados de largura de banda de rede para cada intervalo de tempo.
	object	Os dados de largura de banda de rede para cada intervalo de tempo.
BpsValue	string	The bps value. Unit: bit/second.	11288111
TimeStamp	string	The start time of the time interval. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-12-10T08:00:05Z
HttpsBpsValue	string	The HTTPS bps value. Unit: bit/second.	2000
HttpBpsValue	string	The HTTP bps value. Unit: bit/second.	11286111

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2017-12-10T09:00:00Z",
  "StartTime": "2017-12-10T08:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T08:00:05Z",
        "HttpsBpsValue": "2000",
        "HttpBpsValue": "11286111"
      }
    ]
  }
}

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	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	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.