Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ API Gateway/ Referencia de la API/ API de gateway dedicados (V2)/ Gestión de API/ Publicar una API o poner una API fuera de línea
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

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 invocar en un entorno en el que se haya publicado la API. Las API que no se han publicado no se pueden invocar.

Puede quitar una API de un entorno en el que se haya publicado. Después de esta operación, la API ya no se puede invocar en el entorno.

Método de invocación

Para obtener más información, véase invocación de API.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

Tabla 1 Parámetros de ruta

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.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado 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.
Tabla 3 Parámetros del cuerpo de solicitud

Parámetro

Obligatorio

Tipo

Descripción

action

Sí

String

Operación a realizar.

  • online: publicar las API

  • offline: poner las API fuera de línea

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 exceder los 255 caracteres.

Parámetros de respuesta

Código de estado: 201

Tabla 4 Parámetros del cuerpo de respuesta

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

Tabla 5 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 6 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 7 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 8 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de las solicitudes

Publicación de una API en un entorno

{
  "action" : "online",
  "api_id" : "5f918d104dc84480a75166ba99efff21",
  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
}

Ejemplo de respuestas

Código de estado: 201

Creado

{
  "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

Error en la solicitud

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:action. Please refer to the support documentation"
}

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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

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

201

Creado

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.

Tema principal: Gestión de API