Consulta de versões históricas da API
Função
Esta API é usada para consultar as versões históricas de uma API. O APIG mantém um máximo de 10 versões históricas para cada API em um ambiente.
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 |
|---|---|
| GET | /v1.0/apigw/apis/publish/{api_id}[?env_id,env_name] |
- Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
- As condições de consulta incluem: env_id e env_name.
A tabela a seguir lista os parâmetros no URI.
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| api_id | Sim | String | ID da API |
| env_id | Não | String | ID do ambiente no qual a API foi publicada |
| env_name | Não | String | Nome do ambiente no qual a API foi publicada |
Solicitação
N/D
Resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| total | Integer | Número de versões históricas que correspondem às condições de consulta |
| size | Integer | Comprimento da lista de versões históricas retornadas |
| api_versions | Dicionário | Lista de versões históricas |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| version_id | String | ID da versão de API |
| version_no | String | Versão da API |
| api_id | String | ID da API |
| env_id | String | ID do ambiente no qual a API foi publicada |
| env_name | String | Nome 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 |
| status | Integer | Status da versão, que pode ser:
|
Exemplo de resposta:
{
"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 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 |