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/ API de gateway dedicados (V2)/ Gestión de respuestas de grupo/ Consulta de la respuesta de un tipo de error
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de la respuesta de un tipo de error

Función

Esta API se utiliza para consultar la respuesta de un tipo de error definido para un grupo de API.

Método de invocación

Para obtener más información, véase invocación de API.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type}

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto.

instance_id

Sí

String

ID de gateway, que se puede obtener de la información de gateway en la consola de APIG.

group_id

Sí

String

ID de grupo de API.

response_id

Sí

String

ID de respuesta.

response_type

Sí

String

Tipo de error. Opciones:

  • AUTH_FAILURE: Error de autenticación de IAM o de aplicación.

  • AUTH_HEADER_MISSING: Falta el origen de identidad.

  • AUTHORIZER_FAILURE: Error en la autenticación personalizada.

  • AUTHORIZER_CONF_FAILURE: Se ha producido un error de autorizador personalizado. Por ejemplo, la comunicación falló o se devolvió una respuesta de error.

  • AUTHORIZER_IDENTITIES_FAILURE: Falta o no es válido el origen de identidad del autorizador personalizado de frontend.

  • BACKEND_UNAVAILABLE: El backend no está disponible debido a un error de comunicación.

  • BACKEND_TIMEOUT: La comunicación con el backend está fuera de tiempo.

  • THROTTLED: la solicitud ha sido rechazada debido a una limitación.

  • UNAUTHORIZED: La credencial que utiliza no está autorizada para invocar a la API.

  • ACCESS_DENIED: Acceso denegado. Por ejemplo, se activa la política de control de acceso o se detecta un ataque.

  • NOT_FOUND: No se coincide ninguna API.

  • REQUEST_PARAMETERS_FAILURE: Parámetro de solicitud no válido o método de HTTP no admitido.

  • DEFAULT_4XX: Se ha producido otro error de 4XX.

  • DEFAULT_5XX: Se ha producido otro error de 5XX.

  • THIRD_AUTH_FAILURE: error de autenticación de terceros.

  • THIRD_AUTH_IDENTITIES_FAILURE: Falta o no es válido el origen de la identidad del autorizador de terceros.

  • THIRD_AUTH_CONF_FAILURE: Se ha producido un error del autorizador de terceros. Por ejemplo, la comunicación falló o se devolvió una respuesta de error.

  • ORCHESTRATION_PARAMETER_NOT_FOUND: error en la orquestación de parámetros. No se encontró ningún parámetro de entrada en la solicitud.

  • ORCHESTRATION_FAILURE: error en la orquestación de parámetros. No hay regla de orquestación que coincida.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Description

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener invocando 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 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

status

Integer

Código de estado HTTP de la respuesta. El valor oscila entre 200 y 599, pero no puede ser 444.

body

String

Plantilla de body de respuesta.

headers

Array of ResponseInfoHeader objects

Encabezado de respuesta personalizado.

Longitud del arreglo: 0 - 10

default

Boolean

Indica si la respuesta es la respuesta predeterminada.
Tabla 4 ResponseInfoHeader

Parámetro

Tipo

Descripción

key

String

Clave del encabezado de respuesta de grupo personalizado, que puede contener de 1 a 128 caracteres de letras, dígitos y guiones (-).

value

String

Valor del encabezado de respuesta de grupo personalizado, que es una cadena de 1 a 1,024 caracteres.

Mínimo: 1

Máximo: 1024

Código de estado: 400

Tabla 5 Parámetros del cuerpo 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 6 Parámetros del cuerpo 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 7 Parámetros del cuerpo 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 8 Parámetros del cuerpo 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 9 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "ACCESS_DENIED" : {
    "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
    "default" : true,
    "status" : 403
  }
}

Código de estado: 400

Error en la solicitud

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

Código de estado: 401

Sin autorización

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

Código de estado: 403

Prohibido

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

Código de estado: 404

No se ha encontrado

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

Código de estado: 500

Error del servidor interno

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

Códigos de estado

Código de estado

Descripción

200

Aceptar

400

Error en la solicitud

401

Sin autorización

403

Prohibido

404

No se ha encontrado

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.