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 llamadas de API dentro de un período
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF

Consulta de llamadas de API dentro de un período

Función

Esta API se utiliza para consultar el número de veces que se llama a las API en un grupo de API dentro de un período. La consulta se basa en 1 minuto. Si el intervalo de tiempo es dentro de una hora, el servidor devuelve el número de llamadas a la API realizadas cada minuto.

Por motivos de seguridad, borre los registros de operaciones, incluidos, entre otros, los registros de los directorios ~/.bash_history y /var/log/messages (si los hay), después de ejecutar el comando curl en el servidor para consultar información.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/api/latest

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

api_id

Sí

String

ID de API.

duration

Sí

String

Rango de tiempo (unidad: h o m). Por ejemplo, 1h se refiere a la última hora y 1m se refiere al último minuto.

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

code

String

Código de respuesta.

msg

String

Mensaje de respuesta.

start_time

Long

Marca de tiempo (UTC) de la hora de inicio.

end_time

Long

Marca de tiempo (UTC) de la hora de finalización.

list

Array of StatisticsAPI objects

Datos estadísticos.
Tabla 5 StatisticsAPI

Parámetro

Tipo

Descripción

max_latency

Integer

Latencia máxima.

Unidad: ms

avg_latency

Float

Latencia promedio.

Unidad: ms

req_count

Integer

Número total de solicitudes.

req_count2xx

Integer

Número total de códigos de respuesta 2xx.

req_count4xx

Integer

Número total de códigos de respuesta 4xx.

req_count5xx

Integer

Número total de códigos de respuesta 5xx.

req_count_error

Integer

Errores.

max_inner_latency

Integer

Latencia máxima de gateway.

Unidad: ms

avg_inner_latency

Float

Latencia media de gateway.

Unidad: ms

max_backend_latency

Integer

Máxima latencia de backend.

avg_backend_latency

Float

Latencia media de backend.

output_throughput

Long

Rendimiento descendente (bytes).

input_throughput

Long

Rendimiento ascendente (bytes).

current_minute

Long

Marca de tiempo (UTC) del acceso a la API.

cycle

String

Periodo estadístico.

Valores de enumeración:

  • MINUTE

  • HOUR

  • DAY

api_id

String

ID de API.

group_id

String

ID de grupo de API.

provider

String

Proveedor de API.

req_time

String

Tiempo de solicitud.

register_time

String

Tiempo de grabación.

status

Integer

Estado.

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

{
  "code" : "APIG.0000",
  "start_time" : 1595573280,
  "end_time" : 1595576820,
  "list" : [ {
    "api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9",
    "avg_backend_latency" : 2.71,
    "avg_inner_latency" : 1.57,
    "avg_latency" : 4.14,
    "current_minute" : 1595576640,
    "cycle" : "MINUTE",
    "group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
    "input_throughput" : 1071,
    "max_backend_latency" : 6,
    "max_inner_latency" : 8,
    "max_latency" : 14,
    "output_throughput" : 3790,
    "provider" : "73d69ae0cfcf460190522d06b60f05ad",
    "register_time" : "2020-07-24 15:44:56",
    "req_count" : 7,
    "req_count2xx" : 0,
    "req_count4xx" : 6,
    "req_count5xx" : 1,
    "req_count_error" : 7,
    "req_time" : "2020-07-24 15:44:00",
    "status" : 1
  } ]
}

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.