DescribeVodDomainTrafficData - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Invoca esta operação para consultar os dados de tráfego de um nome de domínio acelerado. Em comparação com a operação DescribeVodDomainRealTimeTrafficData, esta operação suporta um intervalo de consulta de dados históricos mais longo (até 366 dias), mas fornece uma granularidade temporal de dados maior (mínimo de 5 minutos) e latência de dados mais alta.

Descrição da operação

O endereço de serviço desta operação suporta apenas China (Xangai).
Consultas em lote são suportadas. Você pode consultar dados de até 500 nomes de domínio por vez.
Se você não especificar StartTime e EndTime, os dados das últimas 24 horas serão retornados por padrão. Se você especificar StartTime e EndTime, os dados do intervalo de tempo especificado serão retornados.

Granularidade temporal dos dados retornados

A tabela a seguir descreve a granularidade temporal padrão dos dados retornados, o intervalo de dados históricos consultáveis e a latência de dados com base no período especificado por StartTime e EndTime quando Interval não está definido:

Granularidade temporal	Período por consulta	Intervalo de dados históricos consultáveis	Latência de dados
5 minutos	Período por consulta < 3 dias	93 dias	15 minutos
1 hora	3 dias ≤ Período por consulta < 31 dias	186 dias	Geralmente 3 a 4 horas
1 dia	31 dias ≤ Período por consulta ≤ 366 dias	366 dias	Geralmente 4 horas, até 24 horas

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

vod:DescribeVodDomainTrafficData

get

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Não	O nome de domínio acelerado a ser consultado. Se você não especificar este parâmetro, os dados agregados de todos os nomes de domínio acelerados serão retornados por padrão. Consultas em lote são suportadas. Separe vários nomes de domínio com vírgulas (,). Você pode especificar até 500 nomes de domínio por vez. Você pode fazer login no console do ApsaraVideo VOD e escolher Gerenciamento de configuração > Configuração de CDN > Nomes de domínio no painel de navegação à esquerda para visualizar os nomes de domínio acelerados que você adicionou ao ApsaraVideo VOD. Você também pode invocar a operação DescribeVodUserDomains para consultar a lista de nomes de domínio acelerados.	example.com.
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.	2019-01-20T13:59:58Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota A hora de término deve ser posterior à hora de início.	2019-01-20T14:59:58Z
Interval	string	Não	A granularidade temporal das entradas de dados. Unidade: segundos. Valores válidos: 300, 3600 e 86400. Se você não especificar este parâmetro ou especificar um valor não suportado, o valor padrão será usado. A granularidade temporal suportada varia com base no período especificado por `StartTime` e `EndTime`: Menos de 3 dias (exclusivo): 300 (padrão), 3600 e 86400. 3 a 31 dias (exclusivo): 3600 (padrão) e 86400. 31 dias ou mais: 86400 (padrão).	300
IspNameEn	string	Não	O nome do provedor de serviços de Internet (ISP) em inglês. Se você não especificar este parâmetro, os dados de todos os ISPs serão consultados por padrão.	unicom.
LocationNameEn	string	Não	O nome da região em inglês. Se você não especificar este parâmetro, os dados de todas as regiões serão consultados por padrão. Apenas a região de Xangai é suportada.	shanghai.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
EndTime	string	O fim do intervalo de tempo para os dados retornados.	2019-01-20T14:59:58Z
StartTime	string	O início do intervalo de tempo para os dados retornados.	2019-01-20T13:59:58Z
RequestId	string	O ID da solicitação.	D94E471F-1A27-442E-552D-D4D2000C****
DomainName	string	O nome de domínio acelerado.	example.com.
TotalTraffic	string	O tráfego total.	5906662826
DataInterval	string	O intervalo de tempo entre as entradas de dados, que é a granularidade temporal dos dados. Unidade: segundos.	300
TrafficDataPerInterval	object
DataModule	array<object>	Os dados de tráfego para cada intervalo de tempo.
	object	As informações sobre o tráfego de rede.
HttpsDomesticValue	string	O tráfego HTTPS em nós L1 na parte continental da China. Unidade: bytes.	0
Value	string	O tráfego total. Unidade: bytes.	0
OverseasValue	string	O tráfego fora da parte continental da China. Unidade: bytes.	0
HttpsValue	string	O tráfego HTTPS total em nós L1. Unidade: bytes.	0
HttpsOverseasValue	string	O tráfego HTTPS em nós L1 fora da parte continental da China. Unidade: bytes.	0
TimeStamp	string	O carimbo de data e hora dos dados. O horário segue o padrão ISO 8601 e é exibido em UTC.	2019-01-20T13:59:58Z
DomesticValue	string	O tráfego na parte continental da China. Unidade: bytes.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2019-01-20T14:59:58Z",
  "StartTime": "2019-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "TotalTraffic": "5906662826",
  "DataInterval": "300\n",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "0",
        "Value": "0",
        "OverseasValue": "0",
        "HttpsValue": "0",
        "HttpsOverseasValue": "0",
        "TimeStamp": "2019-01-20T13:59:58Z",
        "DomesticValue": "0"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	MissingTimeParameter	The StartTime and EndTime must be both specified.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.