Publicação de uma API
Função
Esta API é usada para publicar uma API em um ambiente especificado. Uma API pode ser chamada em um ambiente somente após ser publicada nele. APIs que não foram publicadas não podem ser chamadas.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
POST |
/v1.0/apigw/apis/publish/{api_id} |
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
api_id |
Sim |
String |
ID da API |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
env_id |
Sim |
String |
ID do ambiente no qual a API será publicada |
remark |
Não |
String |
Descrição sobre a publicação A descrição não pode exceder 255 caracteres. |
Exemplo de solicitação:
{ "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "remark": "Published in the production environment" }
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
publish_id |
String |
ID do registro de publicação |
api_id |
String |
ID da API |
env_id |
String |
ID do ambiente no qual a API foi publicada |
remark |
String |
Descrição sobre a publicação |
publish_time |
Timestamp |
Hora em que a API é publicada |
version_id |
String |
Versão da API |
Exemplo de resposta:
{ "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 status
Código de status |
Descrição |
---|---|
201 |
Criado |
400 |
Solicitação inválida |
401 |
Não autorizado |
403 |
Proibido |
404 |
Não encontrado |
500 |
Erro do servidor interno |