Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda> API Gateway> Referencia de la API> Las API de gateway dedicado (V2)> Consulta de información de monitoreo> Consulta de datos de monitoreo
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF

Consulta de datos de monitoreo

Función

Esta API se utiliza para consultar los datos de métrica de supervisión con una granularidad especificada en un período de tiempo especificado.

URI

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

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

Sí

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.
Tabla 2 Parámetros de Query

Parámetro

Obligatorio

Tipo

Descripción

dim

Sí

String

Dimensión métrica.

  • inbound_eip: Ancho de banda de red pública entrante, que solo admite gateways que admiten el equilibrio de carga.

  • outbound_eip: Ancho de banda de red pública saliente.

Valores de enumeración:

  • inbound

  • outbound

metric_name

Sí

String

Nombre de la métrica.

  • upstream_bandwidth: Ancho de banda saliente.

  • downstream_bandwidth: Ancho de banda entrante.

  • upstream_bandwidth_usage: uso del ancho de banda saliente.

  • downstream_bandwidth_usage: uso del ancho de banda entrante.

  • up_stream: Tráfico saliente.

  • down_stream: Tráfico entrante.

Valores de enumeración:

  • upstream_bandwidth

  • downstream_bandwidth

  • upstream_bandwidth_usage

  • downstream_bandwidth_usage

  • up_stream

  • down_stream

from

Sí

String

Hora de inicio de la consulta. La hora es una marca de tiempo de UNIX y la unidad es ms.

to

Sí

String

Hora de finalización de la consulta. La hora es una marca de tiempo de UNIX y la unidad es ms. El valor del parámetro from debe ser anterior al de parámetro to.

period

Sí

Integer

Monitoreo de granularidad de datos.

  • 1: Datos en tiempo real.

  • 300: 5 minutos.

  • 1200: 20 minutos.

  • 3600: 1 hora.

  • 14400: 4 horas.

  • 86400: 1 día.

Valores de enumeración:

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

filter

Sí

String

Modo acumulativo de datos.

  • average: Valor medio de los datos de métricas en el período acumulativo.

  • max: Valor máximo de los datos de métricas en el período acumulativo.

  • min: Valor mínimo de los datos de métricas en el período acumulativo.

  • sum: Suma de los datos métricos en el período acumulativo.

  • varianza: valor de varianza de los datos de métrica en el período acumulativo.

Valores de enumeración:

  • average

  • max

  • min

  • sum

  • variance

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token.

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

datapoints

Array of MetricData objects

Datos métricos.
Tabla 5 MetricData

Parámetro

Tipo

Descripción

average

Integer

Valor medio de los datos de métricas dentro de un período acumulativo. Este parámetro solo se admite cuando el valor de filtro en la solicitud es average.

max

Integer

Valor máximo de los datos de métricas dentro de un período acumulativo. Este parámetro solo se admite cuando el valor de filtro en la solicitud es max.

min

Integer

Valor mínimo de los datos de métricas dentro de un período acumulativo. Este parámetro solo se admite cuando el valor de filtro en la solicitud es min.

sum

Integer

Suma de datos métricos dentro de un período acumulativo. Este parámetro solo se admite cuando el valor de filtro en la solicitud es sum.

variance

Integer

Valor de varianza de los datos de métricas dentro de un período de acumulación. Este parámetro solo se admite cuando el valor del filtro en la solicitud es varianza.

timestamp

Integer

Hora en que se recopila la métrica. Es una marca de tiempo de UNIX en milisegundos.

unit

String

Unidad de métrica.

Código de estado: 400

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 10 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

Ninguna

Ejemplo de respuestas

Código de estado: 200

OK

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

Código de estado: 400

Bad Request

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

Código de estado: 401

Unauthorized

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

Código de estado: 403

Forbidden

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

Código de estado: 404

Not Found

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

Código de estado: 500

Internal Server Error

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

Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.