DescribeDomainUsageData - CDN: Central de Documentação do Alibaba Cloud

Consulta os dados de uso de nomes de domínio em uma região de cobrança específica.

Descrição da operação

Frequência de chamadas por usuário: 10 chamadas por segundo.
Granularidade de tempo suportada: Dependendo do intervalo de tempo máximo de uma única consulta, o parâmetro de solicitação Interval suporta diferentes granularidades de tempo para os dados consultados. O intervalo de tempo correspondente de dados históricos consultáveis e a latência dos dados são os seguintes:

Granularidade de tempo	Intervalo de tempo máximo de uma única consulta	Intervalo de tempo de dados históricos consultáveis	Latência dos dados
5 minutos	3 dias	93 dias	15 minutos
1 hora	7 dias	186 dias	Geralmente de 3 a 4 horas
1 dia	31 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

cdn:DescribeDomainUsageData

none

*Domínio.

acs:cdn:*:{#accountId}:domain/{#DomainName}

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. Você pode especificar vários nomes de domínio separados por vírgulas (,). Um máximo de 100 nomes de domínio pode ser especificado em uma única consulta. Nota Se este parâmetro for deixado vazio, os dados mesclados de todos os nomes de domínio acelerados na conta serão retornados por padrão.	example.com
StartTime	string	Sim	A hora de início dos dados a serem consultados. Especifique a hora no padrão ISO 8601 em UTC. O formato é yyyy-MM-ddTHH:mm:ssZ. Nota A granularidade de tempo dos dados consultados é de 5 minutos.	2015-12-10T20:00:00Z
EndTime	string	Sim	A hora de término dos dados a serem consultados. 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, e o intervalo de tempo não pode exceder 31 dias.	2015-12-10T22:00:00Z
Field	string	Sim	O tipo de dados a ser consultado. Valores válidos: bps: largura de banda. traf: tráfego. acc: número de solicitações. Nota acc não suporta consultas com base no parâmetro Area.	bps
Type	string	Não	O tipo de dados de uso a serem consultados. Valores válidos: static: conteúdo estático. dynamic: conteúdo dinâmico. all (padrão): todos os tipos.	static
DataProtocol	string	Não	O protocolo dos dados a serem consultados. Valores válidos: http: HTTP. https: HTTPS. quic: QUIC. all (padrão): todos os protocolos anteriores.	all
Area	string	Não	O código da região. Valores válidos: CN (padrão): a parte continental da China. OverSeas: global (exceto a parte continental da China). AP1: Ásia-Pacífico 1. AP2: Ásia-Pacífico 2. AP3: Ásia-Pacífico 3. NA: América do Norte. SA: América do Sul. EU: Europa. MEAA: Oriente Médio e África. all: todas as regiões anteriores.	CN
Interval	string	Não	A granularidade de tempo dos dados a serem consultados, em segundos. Valores válidos: 300 (5 minutos), 3600 (1 hora) e 86400 (1 dia). Interval=300: Você pode consultar dados dos últimos seis meses. O intervalo de tempo máximo de 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 de 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
ServiceType	string	Não

Combinações de parâmetros

A tabela a seguir descreve os mapeamentos entre os dados de cobrança e os valores dos parâmetros. Para obter mais informações sobre como chamar a operação, consulte as solicitações de exemplo.

Dados de cobrança	DataProtocol	Type	Field	Area
Tráfego	all ou não especificado	all ou não especificado	traf	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA
Largura de banda	all ou não especificado	all ou não especificado	bps	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA
Solicitação HTTPS para conteúdo estático	https	static	acc	all
Solicitações HTTP para conteúdo dinâmico	http	dynamic	acc	all
Solicitações HTTPS para conteúdo dinâmico	https	dynamic	acc	all
Solicitação QUIC para conteúdo dinâmico (recursos)	quic	dynamic	acc	all
Solicitação QUIC para conteúdo estático (recursos)	quic	static	acc	all

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de parâmetros.
RequestId	string	O ID da solicitação.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	O nome de domínio acelerado.	example.com
StartTime	string	A hora de início. A hora é exibida no padrão ISO 8601 em UTC.	2015-12-10T20:00:00Z
EndTime	string	A hora de término. A hora é exibida no padrão ISO 8601 em UTC.	2015-12-10T22:00:00Z
Type	string	O tipo de uso.	bps
Area	string	A região de uso.	CN
DataInterval	string	O intervalo de tempo de cada registro, em segundos.	300
UsageDataPerInterval	object
DataModule	array<object>	Os dados de uso para cada intervalo de tempo.
	object	Os dados de uso para cada intervalo de tempo.
Value	string	O valor de uso.	423304182
TimeStamp	string	A hora de início da fatia de tempo. Nota Vários valores TimeStamp retornados nos dados são chamados de fatias de tempo. A hora é exibida no padrão ISO 8601 em UTC.	2015-12-10T21:30:00Z
PeakTime	string	A hora em que o pico de largura de banda é atingido se Field estiver definido como bps. Caso contrário, o valor é o mesmo que TimeStamp.	2015-12-10T21:30:00Z
SpecialValue	string	O uso especial. Nota Este parâmetro é usado para marcar o valor de uso em casos especiais. Você pode ignorar este parâmetro se não houver cobrança especial envolvida.	423304182

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "StartTime": "2015-12-10T20:00:00Z",
  "EndTime": "2015-12-10T22:00:00Z",
  "Type": "bps",
  "Area": "CN",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "SpecialValue": "423304182"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is invalid.	Ocorreu uma exceção ao excluir a região de transmissão ao vivo.
400	InvalidParameterType	The specified Type is invalid.	O parâmetro Type é inválido. Verifique o parâmetro e tente novamente.
400	InvalidParameterField	The specified Field is invalid.	O parâmetro Field é inválido. Verifique o valor e tente novamente.
400	InvalidParameterStartTime	The parameter StartTime is invalid.	O parâmetro StartTime é inválido.
400	InvalidParameterEndTime	The parameter EndTime is invalid.	O parâmetro EndTime é inválido.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	Verifique se as configurações de horário estão corretas. A hora de término não pode ser anterior ou igual à hora de início.
400	InvalidIntervalParameter	The specified Interval is invalid.	A granularidade de tempo especificada é inválida.
400	InvalidTimeSpan	The time span exceeds the limit.	O intervalo de tempo excede o limite. Consulte a documentação da API para configurar um intervalo de tempo de consulta válido.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	A hora de início e a hora de término não correspondem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.