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/ Modificación de una respuesta de grupo

Actualización más reciente 2025-12-22 GMT+08:00

Ver PDF

Modificación de una respuesta de grupo

Función

Esta API se utiliza para modificar una respuesta de un grupo de API.

Método de invocación

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

URI

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

**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.

Parámetros de solicitud

**Tabla 2** 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.

**Tabla 3** Parámetros del cuerpo de solicitud
Parámetro	Obligatorio	Tipo	Descripción
name	Sí	String	Nombre de la respuesta. Ingrese de 1 a 64 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_).
responses	No	Map<String,ResponseInfo>	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.

**Tabla 4** ResponseInfo
Parámetro	Obligatorio	Tipo	Descripción
status	No	Integer	Código de estado HTTP de la respuesta. El valor oscila entre 200 y 599, pero no puede ser 444.
body	No	String	Plantilla de body de respuesta.
headers	No	Array of ResponseInfoHeader objects	Encabezado de respuesta personalizado. Longitud del arreglo: 0 - 10

**Tabla 5** ResponseInfoHeader
Parámetro	Obligatorio	Tipo	Descripción
key	No	String	Clave del encabezado de respuesta de grupo personalizado, que puede contener de 1 a 128 caracteres de letras, dígitos y guiones (-).
value	No	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

Parámetros de respuesta

Código de estado: 200

**Tabla 6** Parámetros del cuerpo de respuesta
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 7** 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 8** 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 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: 401

**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: 403

**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: 404

**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.

Código de estado: 500

**Tabla 13** 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

Modificar una respuesta de un grupo de API

{
  "name" : "response_demo"
}

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "create_time" : "2020-08-12T06:52:02Z",
  "update_time" : "2020-08-12T15:22:21.929863859+08:00",
  "default" : false,
  "id" : "e839b367e10f4ab19d1c5008e476b83a",
  "name" : "response_demo",
  "responses" : {
    "ACCESS_DENIED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 403
    },
    "AUTHORIZER_CONF_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    },
    "AUTHORIZER_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    },
    "AUTHORIZER_IDENTITIES_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "AUTH_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "AUTH_HEADER_MISSING" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "BACKEND_TIMEOUT" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 504
    },
    "BACKEND_UNAVAILABLE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 502
    },
    "DEFAULT_4XX" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true
    },
    "DEFAULT_5XX" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true
    },
    "NOT_FOUND" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 404
    },
    "REQUEST_PARAMETERS_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 400
    },
    "THROTTLED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 429
    },
    "UNAUTHORIZED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_IDENTITIES_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_CONF_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    }
  }
}

Código de estado: 400

Error en la solicitud

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. 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.

Tema principal: Gestión de respuestas de grupo

Tema anterior: Consulta de detalles de respuesta de grupo

Tema siguiente: Eliminación de una respuesta de grupo

Comentarios

¿Le pareció útil esta página?

Sí No

Deje algún comentario

Muchas gracias por sus comentarios. Seguiremos trabajando para mejorar la documentación.

El sistema está ocupado. Vuelva a intentarlo más tarde.

¿Cuáles de los siguientes problemas se presentaron?

Contenido diferente a la de la IU del producto

Descripciones poco claras

Falta de ejemplos o código

Pasos incorrectos

No puedo encontrar lo que necesito

Falta de prácticas recomendadas

Comentarios (opcional)

0/500

Seleccione al menos un tipo de problema e ingrese sus comentarios o sugerencias.

Ingrese 500 caracteres como máximo.

Enviar Cancelar