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 respuestas de grupo
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de respuestas de grupo

Función

Esta API se utiliza para consultar las respuestas de 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

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.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Long

Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0.

Predeterminado: 0

limit

No

Integer

Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500.

Mínimo: 1

Máximo: 500

Predeterminado: 20

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 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 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

responses

Array of ResponsesInfo objects

Lista de respuestas.
Tabla 5 ResponsesInfo

Parámetro

Tipo

Descripción

name

String

Nombre de la respuesta.

responses

Map<String,ResponseInfoResp>

Definición del tipo de respuesta. key indica el tipo de error. Opciones de key:

  • AUTH_FAILURE: Error en la autenticación.

  • AUTH_HEADER_MISSING: Falta el origen de identidad.

  • AUTHORIZER_FAILURE: Error en la autenticación personalizada.

  • AUTHORIZER_CONF_FAILURE: error de autorizador personalizado.

  • AUTHORIZER_IDENTITIES_FAILURE: La fuente de identidad del autorizador personalizado no es válida.

  • BACKEND_UNAVAILABLE: El backend no está disponible.

  • BACKEND_TIMEOUT: Fin del tiempo de espera de backend.

  • THROTTLED: La solicitud fue rechazada debido a la limitación de la solicitud.

  • UNAUTHORIZED: La aplicación que está utilizando no ha sido autorizada para invocar a la API.

  • ACCESS_DENIED: Acceso denegado.

  • NOT_FOUND: No se encuentra ninguna API.

  • REQUEST_PARAMETERS_FAILURE: parámetro de solicitud no válido.

  • DEFAULT_4XX: Se produjo un error 4XX predeterminado.

  • DEFAULT_5XX: Se produjo un error predeterminado de 5XX.

  • THIRD_AUTH_FAILURE: error de autenticación de terceros.

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

  • THIRD_AUTH_CONF_FAILURE: Error de configuración del autorizador de terceros.

  • ORCHESTRATION_PARAMETER_NOT_FOUND: No se introducen parámetros que coincidan con la regla de orquestación de parámetros, lo que provoca un error de orquestación.

  • ORCHESTRATION_FAILURE: Los parámetros de entrada no pueden coincidir con las reglas de orquestación, lo que provoca un error de orquestación.

Cada tipo de error está en formato JSON.

id

String

ID de respuesta.

default

Boolean

Indica si la respuesta de grupo es la respuesta predeterminada.

create_time

String

Tiempo de creación.

update_time

String

Tiempo de actualización.
Tabla 6 ResponseInfoResp

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 7 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 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: 401

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.

Código de estado: 403

Tabla 10 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 11 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 12 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

{
  "total" : 2,
  "size" : 2,
  "responses" : [ {
    "create_time" : "2020-08-12T06:52:02Z",
    "default" : false,
    "id" : "e839b367e10f4ab19d1c5008e476b83a",
    "name" : "response_demo",
    "update_time" : "2020-08-12T06:52:02Z"
  }, {
    "create_time" : "2020-07-31T11:39:23Z",
    "default" : true,
    "id" : "ed8e8c52ab0e4a1c9c809268e5002e64",
    "name" : "default",
    "update_time" : "2020-07-31T11:39:23Z"
  } ]
}

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.