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

Consulta dados de monitoramento de largura de banda para um ou mais nomes de domínio acelerados.

Descrição da operação

Cada conta pode chamar esta operação até 150 vezes por segundo.
Se você não definir o parâmetro StartTime ou EndTime, a solicitação retorna os dados coletados nas últimas 24 horas. Se você definir ambos os parâmetros, a solicitação retorna os dados coletados dentro do intervalo de tempo especificado.

Granularidade de tempo

A granularidade de tempo suportada pelo parâmetro Interval, o período máximo de tempo no qual os dados históricos estão disponíveis e o atraso dos dados variam de acordo com o intervalo de tempo máximo por consulta, conforme descrito na tabela a seguir.

Granularidade de tempo	Intervalo de tempo máximo por consulta	Dados históricos disponíveis	Atraso dos dados
5 minutos	3 dias	93 dias	15 minutos
1 hora	31 dias	186 dias	4 horas
1 dia	366 dias	366 dias	04:00 do dia seguinte

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

none

*Domain

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. Você pode especificar até 500 nomes de domínio em cada solicitação. Separe múltiplos nomes de domínio com vírgulas (,). Por padrão, esta operação consulta dados de largura de banda para todos os nomes de domínio acelerados que pertencem à sua conta Alibaba Cloud.	example.com
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2020-05-14T09:50:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota O horário de término deve ser posterior ao horário de início.	2020-05-14T10:00:00Z
Interval	string	Não	A granularidade de tempo das entradas de dados. Unidade: segundos. A granularidade de tempo varia de acordo com o intervalo de tempo máximo por consulta. Valores válidos: 300 (5 minutos), 3600 (1 hora) e 86400 (1 dia). Para mais informações, consulte Notas de uso.	300
IspNameEn	string	Não	O nome do provedor de serviços de Internet (ISP). Você pode chamar a operação DescribeCdnRegionAndIsp para consultar nomes de ISPs. Se você não definir este parâmetro, os dados de todos os ISPs serão consultados.	telecom
LocationNameEn	string	Não	O nome da região. Você pode chamar a operação DescribeCdnRegionAndIsp para consultar regiões. Se você não especificar uma região, os dados de todas as regiões serão consultados.	beijing

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndTime	string	O fim do intervalo de tempo durante o qual os dados foram consultados.	2015-12-10T20:00Z
StartTime	string	O início do intervalo de tempo durante o qual os dados foram consultados.	2020-05-14T09:50:00Z
RequestId	string	O ID da solicitação.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
IspNameEn	string	O nome do ISP.	unicom
LocationNameEn	string	O nome da região.	beijing
DomainName	string	O nome de domínio acelerado.	example.com
DataInterval	string	O intervalo de tempo entre as entradas de dados retornadas. Unidade: segundos.	300
BpsDataPerInterval	object
DataModule	array<object>	A lista de entradas de dados de largura de banda retornadas em cada intervalo.
	object
HttpsDomesticValue	string	The bandwidth data for HTTPS requests in the Chinese mainland. When the bandwidth data is queried by ISP, this parameter is empty.	11286111
Value	string	The bandwidth. Unit: bit/s.	11288111
OverseasValue	string	The bandwidth data in regions outside the Chinese mainland. When the bandwidth data is queried by ISP, this parameter is empty.	2000
HttpsValue	string	The bandwidth value for HTTPS requests. Unit: bit/s.	11288111
HttpsOverseasValue	string	The bandwidth data for HTTPS requests in regions outside the Chinese mainland. When the bandwidth data is queried by ISP, this parameter is empty.	2000
TimeStamp	string	The timestamp of the data returned.	2015-12-10T20:00:00Z
DomesticValue	string	The bandwidth value in the Chinese mainland. When the bandwidth data is queried by ISP, this parameter is empty.	11286111

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2015-12-10T20:00Z",
  "StartTime": "2020-05-14T09:50:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "IspNameEn": "unicom",
  "LocationNameEn": "beijing",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "11286111",
        "Value": "11288111",
        "OverseasValue": "2000",
        "HttpsValue": "11288111",
        "HttpsOverseasValue": "2000",
        "TimeStamp": "2015-12-10T20:00:00Z",
        "DomesticValue": "11286111"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.