Verificación de la definición de API
Función
Esta API se utiliza para verificar la definición de la API, es decir, si la ruta o el nombre de la API ya existe.
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}/apis/check
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 | No | String | Nombre de la API. Este parámetro es obligatorio cuando type se establece en name. |
req_method | No | String | Método de solicitud. Este parámetro es obligatorio cuando type se establece en path. |
req_uri | No | String | Dirección de acceso de la API. Este parámetro es obligatorio cuando type se establece en path. |
match_mode | No | String | Modo de coincidencia de API:
Este parámetro es obligatorio cuando type se establece en path. |
group_id | No | String | ID de grupo. Este parámetro es obligatorio para comprobar si hay definiciones de API duplicadas en el grupo. |
roma_app_id | No | String | ID de aplicación de integración. Esto no se soporta actualmente. |
api_id | No | String | ID de la API que se va a comparar. |
type | Sí | String | Tipo de verificación:
|
Parámetros de respuesta
Código de estado: 400
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Descripción de error. |
Código de estado: 401
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Descripción de error. |
Código de estado: 403
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Descripción de error. |
Código de estado: 404
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Descripción de error. |
Código de estado: 500
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Descripción de error. |
Ejemplo de las solicitudes
{
"type" : "name",
"name" : "api_demo"
} Ejemplo de respuestas
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.3202",
"error_msg" : "The API name already exists, api_name:api_demo"
} 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:f0fa1789-3b76-433b-a787-9892951c620ec"
} 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 |
|---|---|
204 | Sin contenido |
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.
