Consulta de versiones de la API de VPCEP
Función
Esta API se utiliza para consultar versiones de las API de VPCEP.
URI
GET /
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
Content-Type |
Sí |
String |
Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor predeterminado application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía según el tipo de flujo. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
versions |
Matriz de objetos de VersionObject |
Muestra las versiones de VPCEP. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Especifica el estado de la versión. ● CURRENT: indica una versión principal. ● SUPPORT: indica una versión anterior que todavía es compatible. ● DEPRECATED: indica la versión obsoleta que puede eliminarse más tarde. |
id |
String |
Especifica el ID de versión de la API. |
updated |
String |
Especifica la hora en la que se publicó la versión de la API. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
version |
String |
Especifica el número de versión admitida. |
min_version |
String |
Especifica el número de microversión admitida. Si las API no admiten microversiones, el parámetro se deja en blanco. |
links |
Matriz de objetos de Link |
Especifica la URL de la API. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
Especifica la dirección de referencia de la versión actual de la API. |
type |
String |
Especifica el tipo MIME del cuerpo de la solicitud. El valor es application/json. |
rel |
String |
Especifica la relación entre la versión actual de la API y la dirección a la que se hace referencia. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 405
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 406
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 407
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 408
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 409
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 501
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 502
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 503
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Código de estado: 504
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Objeto de Error |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Ejemplo de solicitudes
GET https://{endpoint}/
Ejemplo de respuestas
Código de estado: 200
El servidor ha procesado correctamente la solicitud.
{ "versions" : [ { "updated" : "2018-09-30T00:00:00Z", "version" : "1", "min_version" : "", "status" : "CURRENT", "id" : "v1", "links" : [ { "href" : "https://{vpcep_uri}/v1", "type" : "application/json", "rel" : "self" } ] } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
El servidor ha procesado correctamente la solicitud. |
400 |
El servidor no pudo entender la solicitud debido a una sintaxis mal formada. |
401 |
La página solicitada requiere un nombre de usuario y una contraseña. |
403 |
El servidor entendió la solicitud, pero se niega a cumplirla. |
404 |
El servidor no ha encontrado nada que coincida con el URI de solicitud. |
405 |
El método especificado en la línea de solicitud no está permitido para el recurso identificado por el URI de solicitud. |
406 |
El recurso identificado por la solicitud sólo es capaz de generar entidades de respuesta que tienen características de contenido no aceptables de acuerdo con las cabeceras de aceptación enviadas en la solicitud. |
407 |
El cliente primero debe autenticarse con el proxy. |
408 |
El cliente no produjo una solicitud dentro del tiempo que el servidor estaba preparado para esperar. |
409 |
No se pudo completar la solicitud debido a un conflicto con el estado actual del recurso. |
500 |
Error al completar la solicitud. Anormalidad del servicio. |
501 |
Error al completar la solicitud. El servidor no admite la función solicitada. |
502 |
Error al completar la solicitud. porque el servidor ha recibido una respuesta no válida. |
503 |
Error al completar la solicitud. porque el sistema no está disponible. |
504 |
Fin del tiempo de espera del gateway |
Códigos de error
Consulte Códigos de error.