Importación de API de forma asíncrona
Función
Esta API se utiliza para importar las API. El contenido del archivo importado debe cumplir con el estándar Swagger. Para obtener detalles sobre los campos extendidos personalizados de APIG, véase la sección "Importación y exportación de API" > "Definición extendida" en la Guía de usuario del API Gateway.
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}/openapi/async-import
|
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 |
|---|---|---|---|
|
is_create_group |
No |
Boolean |
Si se debe crear un nuevo grupo. Predeterminado: true |
|
group_id |
No |
String |
ID de grupo de API. Este parámetro es necesario si is_create_group se establece en false. |
|
extend_mode |
No |
String |
Modo de importación de información extendida.
Predeterminado: merge |
|
simple_mode |
No |
Boolean |
Si se desea habilitar la importación rápida. Predeterminado: false |
|
mock_mode |
No |
Boolean |
Si se debe habilitar el backend de simulación. Predeterminado: false |
|
api_mode |
No |
String |
Modo de importación.
Predeterminado: merge |
|
file_name |
Sí |
File |
Cuerpo de solicitud en formato JSON o YAML para importar las API |
Parámetros de respuesta
Código de estado: 202
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
task_id |
String |
ID de la tarea. |
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: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Importación de las API
{
"is_create_group" : false,
"group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
"file_name" : "APIGroup_test.json"
}
Ejemplo de respuestas
Código de estado: 202
Aceptado
{
"task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2"
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.3603",
"error_msg" : "The input data is too long"
}
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: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
202 |
Aceptado |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.
