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

Consulta dados de monitoramento, incluindo a quantidade de tráfego de rede e o número de visitas por diretório.

Descrição da operação

Esta operação está disponível apenas para usuários que estão na lista de permissões. Se o valor de pico de largura de banda diário de suas cargas de trabalho atingir 10 Gbit/s, você pode abrir um ticket para solicitar a inclusão na lista de permissões.
Cada conta pode chamar esta operação até 6.000 vezes por segundo.
A coleta de dados por diretório está disponível apenas para nomes de domínio especificados na sua conta Alibaba Cloud. Ela não pode ser ativada para todos os nomes de domínio da sua conta Alibaba Cloud.
O tamanho médio dos arquivos que pertencem ao nome de domínio deve ser maior que 1 MB.
O número de diretórios especificados para um único nome de domínio não pode exceder 100. Se o número de diretórios exceder 100, a precisão dos dados será reduzida.
Se você não definir StartTime ou EndTime, os dados coletados nas últimas 24 horas serão consultados. Se você definir StartTime e EndTime, os dados dentro do intervalo de tempo especificado serão consultados.
Você pode consultar dados coletados nos últimos 30 dias.

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

get

*Domain

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página a ser retornada. As páginas começam na página 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: inteiros de 1 a 1000.	20
Path	string	Não	Os caminhos que você deseja consultar. Separe os caminhos com barras (/). Se você não definir este parâmetro, todos os caminhos serão consultados. Se você definir o valor como um diretório, ele deve terminar com uma barra (/). Nota A correspondência aproximada não é suportada. Se você deseja que os dados sejam coletados com base em um diretório, pode especificar um diretório específico, por exemplo, directory/path/. Nesse caso, os dados de largura de banda são coletados com base em directory/path/.	/path/
StartTime	string	Não	Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Exemplo: 2016-10-20T04:00:00Z.	2016-10-20T04:00:00Z
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. O intervalo entre a hora de início e a hora de fim deve ser inferior a 30 dias. Exemplo: 2016-10-21T04:00:00Z.	2016-10-21T04:00:00Z
DomainName	string	Sim	O nome de domínio acelerado. Nota Você pode especificar apenas um nome de domínio em cada chamada.	example.com

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	O fim do intervalo de tempo durante o qual os dados foram consultados.	2017-09-30T17:00:00Z
StartTime	string	O início do intervalo de tempo durante o qual os dados foram consultados.	2017-09-30T16:00:00Z
PageSize	integer	O número de entradas retornadas por página.	20
PageNumber	integer	O número da página retornada. As páginas começam na página 1.	1
TotalCount	integer	O número total de entradas retornadas.	2
DomainName	string	O nome de domínio acelerado.	example.com
DataInterval	string	O intervalo de tempo. Unidade: segundos.	300
PathDataPerInterval	object
UsageData	array<object>	Uma lista de valores de largura de banda coletados em cada intervalo de tempo.
	object
Path	string	The path.	/path/
Time	string	The point in time.	2017-09-30T16:00:00Z
Acc	integer	The number of visits to the URL.	10
Traffic	integer	The amount of network traffic. Unit: bytes.	346
RequestId	string	O ID da solicitação.	DE81639B-DAC1-4C76-AB72-F34B836837D5

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2017-09-30T17:00:00Z",
  "StartTime": "2017-09-30T16:00:00Z",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 2,
  "DomainName": "example.com",
  "DataInterval": "300",
  "PathDataPerInterval": {
    "UsageData": [
      {
        "Path": "/path/",
        "Time": "2017-09-30T16:00:00Z",
        "Acc": 10,
        "Traffic": 346
      }
    ]
  },
  "RequestId": "DE81639B-DAC1-4C76-AB72-F34B836837D5"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidPageSize.Malformed	PageSize must be of type Integer
400	InvalidPageSize.ExceedsMaximum	PageSize should be less than or equal to 1000
400	InvalidPageSize.ExceedsMinimum	PageSize should be greater than or equal to 1
400	InvalidPath.Malformed	Path must be of type String
400	InvalidStartTime.Malformed	StartTime must be of type String
400	InvalidEndTime.Malformed	EndTime must be of type String
400	InvalidDomainName.Malformed	DomainName must be of type String
400	MissingParameter	DomainName is required
400	InvalidDomainName.TooShort	DomainName should be at least 1 chars long
400	InvalidPageNumber.Malformed	PageNumber must be of type Integer
400	InvalidPageNumber.ExceedsMinimum	PageNumber should be greater than or equal to 1
400	InvalidTime.OverRange	Specified StartTime or EndTime is over range

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.