Consulta de versiones históricas de API
Función
Esta API se utiliza para consultar las versiones históricas de una API. APIG conserva un máximo de 10 versiones históricas para cada API en un entorno.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
GET |
/v1.0/apigw/apis/publish/{api_id}[?env_id,env_name] |
- Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
- Las condiciones de consulta incluyen env_id y env_name.
En la siguiente tabla se enumeran los parámetros del URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
api_id |
Sí |
String |
ID de API |
env_id |
No |
String |
ID del entorno en el que se ha publicado la API |
env_name |
No |
String |
Nombre del entorno en el que se ha publicado la API |
Solicitud
N/A
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total |
Integer |
Número de versiones históricas que coinciden con las condiciones de consulta |
size |
Integer |
Longitud de la lista de versiones históricas devueltas |
api_versions |
Dictionary |
Lista de versiones históricas |
Parámetro |
Tipo |
Descripción |
---|---|---|
version_id |
String |
ID de versión de API |
version_no |
String |
Versión de la API |
api_id |
String |
ID de API |
env_id |
String |
ID del entorno en el que se ha publicado la API |
env_name |
String |
Nombre del entorno en el que se ha publicado la API |
remark |
String |
Descripción de la publicación |
publish_time |
Timestamp |
Hora de publicación de la API |
status |
Integer |
Estado de la versión, que puede ser:
|
Ejemplo de respuesta:
{ "total": 1, "size": 1, "api_versions": [ { "version_id": "04c194dc7b5340ed942f2451702060da", "version_no": "20180722102526", "api_id": "acf141aa6279415088b593a4bbb55eed", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "publish_time": "2018-04-14T07:32:23Z", "status": 2 } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |