Publicar una API o poner una API fuera de línea
Función
Esta API se utiliza para publicar una API o poner una API fuera de línea.
Una API solo se puede llamar en un entorno en el que se haya publicado la API. Las API que no se han publicado no se pueden llamar.
Puede eliminar una API de un entorno en el que se haya publicado. Después de esta operación, la API ya no se puede llamar en el entorno.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando 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 |
|---|---|---|---|
action |
Sí |
String |
Operación a realizar.
Valores de enumeración:
|
env_id |
Sí |
String |
ID del entorno en el que se publicará la API. |
api_id |
Sí |
String |
ID de la API que se va a publicar o poner fuera de línea. |
remark |
No |
String |
Descripción de la publicación. No puede superar los 255 caracteres. |
Parámetros de respuesta
Código de estado: 201
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 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. |
Solicitudes de ejemplo
{
"action" : "online",
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
}
Ejemplo de respuestas
Código de estado: 201
Created
{
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
"publish_time" : "2020-08-03T01:36:00.592970615Z",
"version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b"
}
Código de estado: 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:action. Please refer to the support documentation"
}
Código de estado: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
Not Found
{
"error_code" : "APIG.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}
Código de estado: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
Código de estado |
Descripción |
|---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.
