Consulta de estatísticas de uso da largura de banda
Função
Essa API é usada para consultar estatísticas de uso de largura de banda. Observe que as API relacionadas ao painel não podem ser usadas para consultar dados por tempo personalizado. Somente os dados exibidos no console para ontem, hoje, últimos 3 dias, últimos 7 dias e últimos 30 dias podem ser consultados.
URI
GET /v1/{project_id}/waf/overviews/bandwidth/timeline
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. Para obtê-lo, vá para o console de gerenciamento do Huawei Cloud e passe o cursor sobre seu nome de usuário. Na janela exibida, escolha My Credentials.Em seguida, na área Projects, visualize Project ID correspondente. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
Você pode obter o ID chamando a API ListEnterpriseProject do EPS. |
from |
Sim |
Long |
Hora de início (13 dígitos timestamp em milissegundos). Este parâmetro deve ser usado junto com to. |
to |
Sim |
Long |
Hora de término (timestamp de 13 dígitos em milissegundos). Este parâmetro deve ser usado junto com from. |
hosts |
Não |
String |
Os ID de nome de domínio. No modo de nuvem, os ID de nome de domínio podem ser obtidos chamando a API ListHost. No modo dedicado, os ID de nome de domínio podem ser obtidos chamando a API ListPremiumHost. Por padrão, esse parâmetro não é especificado e os dados de uso de largura de banda de cada nome de domínio protegido no projeto são consultados. |
instances |
Não |
String |
Os ID de instância que você deseja consultar. Esse parâmetro é necessário somente para instâncias dedicadas do WAF e instâncias de balanceamento de carga (modo ELB). |
group_by |
Não |
String |
Dimensão de exibição. Por exemplo, se o valor for DAY, os dados serão exibidos por dia. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho da resposta). |
Content-Type |
Sim |
String |
Tipo de conteúdo Padrão: application/json;charset=utf8 |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
[items] |
Array of BandwidthStatisticsTimelineItem objects |
Estatísticas de largura de banda ao longo do tempo |
Parâmetro |
Tipo |
Descrição |
---|---|---|
key |
String |
Valor da chave. As opções são BANDWIDTH, IN_BANDWIDTH, e OUT_BANDWIDTH. |
timeline |
Array of TimeLineItem objects |
Estatísticas da linha do tempo do valor da chave correspondente. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Código de estado: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro |
error_msg |
String |
Mensagem de erro |
Exemplos de solicitações
GET https://{Endpoint}/v1/{project_id}/waf/overviews/bandwidth/timeline?enterprise_project_id=0&from=1650470400196&to=1650522936196
Exemplo de respostas
Código de estado: 200
OK
[ { "key" : "IN_BANDWIDTH", "timeline" : [ { "time" : 1650470400000, "num" : 0 } ] }, { "key" : "OUT_BANDWIDTH", "timeline" : [ { "time" : 1650470400000, "num" : 0 } ] }, { "key" : "BANDWIDTH", "timeline" : [ { "time" : 1650470400000, "num" : 0 } ] } ]
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Falha na solicitação. |
401 |
O token não tem permissões necessárias. |
500 |
Erro de servidor interno. |
Códigos de erro
Consulte Códigos de erro.