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

Consulta dados de tráfego de aceleração ou uso de largura de banda.

Descrição da operação

Atualmente, a única região de serviço suportada é China (Xangai).
Consultas em lote de nomes de domínio são suportadas. Separe vários nomes de domínio com vírgulas (,). Você pode consultar até 100 nomes de domínio por vez. Se este parâmetro for deixado vazio, os dados de todos os nomes de domínio da conta serão retornados.
Você pode consultar dados do último ano. O intervalo de tempo máximo para uma única consulta é de 3 meses. Se o intervalo de tempo da consulta for de 1 a 3 dias, os dados serão retornados com granularidade horária. Se o intervalo de tempo da consulta for de 4 dias ou mais, os dados serão retornados com granularidade diária.

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

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. Se este parâmetro for deixado vazio, os dados mesclados 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 (,).	example.com.
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T10:20:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. A hora final deve ser posterior à hora inicial. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T12:20:00Z
Field	string	Sim	O tipo de dados. Valores válidos: bps: largura de banda. traf: tráfego.	bps.
Type	string	Não	O tipo de dados de uso a serem obtidos. Valores válidos: static: conteúdo estático. dynamic: conteúdo dinâmico. all: todo o conteúdo.	static.
Area	string	Não	O código da região. Valor padrão: CN (continente chinês). Valores válidos: CN: continente chinês. OverSeas: fora do continente chinês.	CN
Interval	string	Não	Força a obtenção de dados na granularidade de tempo especificada, em segundos. Valores válidos: 300 (5 minutos), 3600 (1 hora) e 86400 (1 dia). Interval=300: Você pode consultar dados do último semestre. O intervalo de tempo máximo para uma única consulta é de 3 dias. Interval=3600 ou 86400: Você pode consultar dados do último ano. Se Interval não for especificado: O intervalo de tempo máximo para uma única consulta é de 1 mês. Se o intervalo de tempo da consulta for de 1 a 3 dias, os dados serão retornados com granularidade horária. Se o intervalo de tempo da consulta for de 4 dias ou mais, os dados serão retornados com granularidade diária.	300

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	A hora final. O horário está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T12:20:00Z
Type	string	O tipo de dados. Valores válidos: bps: largura de banda. traf: tráfego.	bps.
StartTime	string	A hora inicial. O horário está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T10:20:00Z
RequestId	string	O ID da solicitação.	B955107D-E658-4E77-****-E0AC3D31693E
Area	string	A região de uso.	CN
DomainName	string	As informações do nome de domínio acelerado.	example.com.
DataInterval	string	O intervalo de tempo entre registros. Unidade: segundos.	300
UsageDataPerInterval	object
DataModule	array<object>	Os dados de uso de tráfego ou largura de banda.
	object
Value	string	Os dados de tráfego ou largura de banda. Unidade: bit/s.	2592.3920000000003
TimeStamp	string	O carimbo de data e hora dos dados retornados. A hora está no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2015-12-10T10:00:00Z

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2015-12-10T12:20:00Z",
  "Type": "bps",
  "StartTime": "2015-12-10T10:20:00Z",
  "RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "2592.3920000000003",
        "TimeStamp": "2015-12-10T10:00:00Z"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter	The specified parameter is not valid.
400	InvalidParameterProduct	The specified parameter Product is invalid.
400	InvalidParameterArea	The specified parameter Area is invalid.
400	InvalidParameterField	The specified parameter Field is invalid.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.
400	InvalidParameterInterval	The specified Interval is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.