Alternação da versão de uma API
Função
Esta API é usada para alternar a versão de uma API. Uma versão é gerada com base na definição atual de uma API quando a API é publicada. A versão registra a definição e o status da API quando ela é publicada.
Você pode alternar entre várias versões de uma API, mas apenas uma versão de uma API entra em vigor no mesmo ambiente.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento. |
| instance_id | Sim | String | ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG. |
| api_id | Sim | String | ID da API. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| version_id | Não | String | ID da versão de API. |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| publish_id | String | ID do registro da publicação. |
| api_id | String | ID da API. |
| api_name | String | Nome da API. |
| env_id | String | ID do ambiente no qual a API foi publicada. |
| remark | String | Descrição sobre a publicação. |
| publish_time | String | Tempo de publicação. |
| version_id | String | Versão da API atualmente em uso. |
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 401
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 404
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 500
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Exemplo de solicitações
{
"version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b"
} Exemplo de respostas
Código de status: 200
OK
{
"publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
"publish_time" : "2020-08-03T03:27:49.483295655Z"
} Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2000",
"error_msg" : "Parameter error: Serialization error: unexpected end of JSON input"
} Código de status: 401
Não autorizado
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de status: 403
Proibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de status: 404
Não encontrado
{
"error_code" : "APIG.3022",
"error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
} Código de status: 500
Erro do servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
| 400 | Solicitação inválida |
| 401 | Não autorizado |
| 403 | Proibido |
| 404 | Não encontrado |
| 500 | Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.
