Publicar varias APIs o quitar varias APIs desconectadas
Función
Esta API se utiliza para publicar varias API en un entorno o para eliminar varias API del entorno en el que se han publicado.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
POST |
/v1.0/apigw/apis/publish[?action] |
En la siguiente tabla se muestra el parámetro en el URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
action |
No |
String |
online: publicar offline: desconectarse |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
apis |
Sí |
String Array |
IDs de las API que se publicarán o se desconectarán |
env_id |
Sí |
String |
ID de entorno |
remark |
No |
String |
Descripción de la publicación La descripción no puede superar los 255 caracteres. |
Ejemplo de solicitud:
{ "apis": ["81efcfd94b8747a0b21e8c04144a4e8c","7addcd00cfab433984b1d8bf2fe08aaa"], "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "remark": "Published in the production environment" }
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
success |
Array |
Mensaje para una publicación exitosa de la API o desconectarse |
failure |
Array |
Mensaje de error y API que no se publican o se desconectan |
Parámetro |
Tipo |
Descripción |
---|---|---|
publish_id |
String |
ID de registro de publicación |
api_id |
String |
ID de una API publicada correctamente |
api_name |
String |
Nombre de la API |
env_id |
String |
ID 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 |
version_id |
String |
Versión de la API |
Parámetro |
Tipo |
Descripción |
---|---|---|
api_id |
String |
ID de una API que se ha puesto desconectado correctamente |
api_name |
String |
Nombre de la API |
Parámetro |
Tipo |
Descripción |
---|---|---|
api_id |
String |
ID de una API que no se publica o se desconecta |
api_name |
String |
Nombre de la API |
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de error |
Ejemplo de respuesta:
{ "success": [{ "publish_id": "5b729aa252764739be2c37ef0d66dc63", "api_id": "7addcd00cfab433984b1d8bf2fe08aaa", "api_name": "testApi", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "version_id": "3d9dcb733ba34352b0d02f85fd16b026", "remark": "string", "publish_time": "2018-07-26T13:18:04.1079916Z" }], "failure": [{ "api_id": "81efcfd94b8747a0b21e8c04144a4e8c", "error_code": "APIG.3002", "error_msg": "api with id 81efcfd94b8747a0b21e8c04144a4e8c not found" }] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |