Cambio de la versión de una API
Función
Esta API se utiliza para cambiar la versión de una API. Se genera una versión basada en la definición actual de una API cuando se publica la API. La versión registra la definición y el estado de la API cuando se publica.
Puede cambiar entre varias versiones de una API, pero solo una versión de una API tiene efecto en el mismo entorno.
Método de invocación
Para obtener más información, véase invocación de API.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
|
api_id |
Sí |
String |
ID de API. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
version_id |
No |
String |
ID de versión de la API. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
publish_id |
String |
ID del registro de publicación. |
|
api_id |
String |
ID de API. |
|
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 |
String |
Tiempo de publicación. |
|
version_id |
String |
Versión de la API actualmente en uso. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Cambio de una API a una versión especificada
{
"version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b"
}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"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 estado: 400
Error en la solicitud
{
"error_code" : "APIG.2000",
"error_msg" : "Parameter error: Serialization error: unexpected end of JSON input"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3022",
"error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.