Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ API Gateway/ Referência de API/ APIs de gateway dedicadas (V2)/ Monitoramento de consultas de informação/ Consulta de dados de monitoramento
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de dados de monitoramento

Função

Esta API é usada para consultar os dados da métrica de monitoramento em uma granularidade especificada em um período de tempo especificado.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

dim

Sim

String

Dimensão métrica.

  • inbound_eip: largura de banda de rede pública de entrada, que é suportada apenas por gateways que suportam balanceamento de carga.

  • outbound_eip: largura de banda da rede pública de saída.

Valores de enumeração:

  • inbound

  • outbound

metric_name

Sim

String

Nome da métrica.

  • upstream_bandwidth: largura de banda de saída.

  • downstream_bandwidth: largura de banda de entrada.

  • upstream_bandwidth_usage: uso de largura de banda de saída.

  • downstream_bandwidth_usage: uso da largura de banda de entrada.

  • up_stream: tráfego de saída.

  • down_stream: tráfego de entrada.

Valores de enumeração:

  • upstream_bandwidth

  • downstream_bandwidth

  • upstream_bandwidth_usage

  • downstream_bandwidth_usage

  • up_stream

  • down_stream

from

Sim

String

Hora de início da consulta. A hora é um carimbo de data/hora UNIX e a unidade é ms.

to

Sim

String

Hora de fim da consulta. A hora é um carimbo de data/hora UNIX e a unidade é ms. O valor do parâmetro from deve ser anterior ao do parâmetro to.

period

Sim

Integer

Monitorar a granularidade dos dados.

  • 1: dados em tempo real.

  • 300: 5 minutos.

  • 1200: 20 minutos.

  • 3600: 1 hora.

  • 14400: 4 horas.

  • 86400: 1 dia.

Valores de enumeração:

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

filter

Sim

String

Modo de acúmulo de dados.

  • average: valor médio dos dados de métrica no período de acúmulo.

  • max: valor máximo dos dados de métrica no período de acúmulo.

  • min: o valor mínimo dos dados de métrica no período de acúmulo.

  • sum: soma dos dados métricos no período de acúmulo.

  • variance: valor de variação dos dados de métrica no período de acúmulo.

Valores de enumeração:

  • average

  • max

  • min

  • sum

  • variance

Parâmetros de solicitação

Tabela 3 Parâmetros do cabeçalho 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 usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

datapoints

Array of MetricData objects

Dados métricos.
Tabela 5 MetricData

Parâmetro

Tipo

Descrição

average

Integer

Valor médio dos dados de métrica dentro de um período de acúmulo. Este parâmetro é suportado apenas quando o valor de filtro na solicitação é médio.

max

Integer

Valor máximo dos dados de métrica dentro de um período de acúmulo. Este parâmetro é suportado apenas quando o valor de filtro na solicitação é max.

min

Integer

Valor mínimo dos dados de métrica dentro de um período de acúmulo. Este parâmetro é suportado apenas quando o valor de filtro na solicitação é min.

sum

Integer

Soma dos dados métricos dentro de um período de acúmulo. Este parâmetro é suportado apenas quando o valor de filtro na solicitação é soma.

variance

Integer

Valor de variação de dados de métrica dentro de um período de acúmulo. Este parâmetro é suportado apenas quando o valor de filtro na solicitação é variância.

timestamp

Integer

Hora em que a métrica é coletada. É um carimbo de data/hora UNIX em milissegundos.

unit

String

Unidade métrica.

Código de status: 400

Tabela 6 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 401

Tabela 7 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 403

Tabela 8 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 404

Tabela 9 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 10 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "datapoints" : [ {
    "average" : 5,
    "timestamp" : 1665304920000,
    "unit" : "Byte"
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3002",
  "error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.