Publicación de una API
Función
Esta API se utiliza para publicar una API en un entorno específico. Una API se puede invocar en un entorno solo después de que se publique en él. Las API que no se han publicado no se pueden llamar.
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/{api_id} |
En la siguiente tabla se muestra el parámetro en el URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
api_id |
Sí |
String |
ID de API |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
env_id |
Sí |
String |
ID del entorno en el que se publicará la API |
remark |
No |
String |
Descripción de la publicación La descripción no puede superar los 255 caracteres. |
Ejemplo de solicitud:
{ "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "remark": "Published in the production environment" }
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
publish_id |
String |
ID del registro de publicación |
api_id |
String |
ID de 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 |
Ejemplo de respuesta:
{ "publish_id": "5b729aa252764739be2c37ef0d66dc63", "api_id": "7addcd00cfab433984b1d8bf2fe08aaa", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "version_id": "3d9dcb733ba34352b0d02f85fd16b026", "remark": "string", "publish_time": "2018-07-26T13:18:04.1079916Z" }
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 |