Configuración de una función para un gateway
Función
Esta API se utiliza para configurar una función para un gateway.
Para obtener detalles sobre las funciones admitidas y los ejemplos de configuración, véase el "Apéndice" > "Características admitidas" en este documento.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/features
| 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. |
Parámetros 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ámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| name | Sí | String | Nombre de característica. Mínimo: 1 Máximo: 64 |
| enable | Sí | Boolean | Indica si se debe habilitar la característica o no. |
| config | No | String | Configuración de parámetros. |
Parámetros de respuesta
Código de estado: 201
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de característica. |
| name | String | Nombre de característica. Mínimo: 1 Máximo: 64 |
| enable | Boolean | Indica si se debe habilitar la característica o no. |
| config | String | Configuración de parámetros. |
| instance_id | String | ID de gateway. |
| update_time | String | Tiempo de actualización de la característica. |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 401
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 403
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 500
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Ejemplo de las solicitudes
Enabling the app_api_key switch
{
"name" : "app_api_key",
"config" : "on",
"enable" : true
} Ejemplo de respuestas
Código de estado: 201
Creado
{
"config" : "on",
"enable" : true,
"id" : "db9a9260cd3e4a16a9b5747a65d3ffaa",
"instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
"name" : "app_api_key",
"update_time" : "2020-08-24T01:17:31.041984021Z"
} Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2000",
"error_msg" : "unrecognized feature app-api-key"
} 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.3030",
"error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
} 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 |
|---|---|
| 201 | Creado |
| 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.
