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)/ Importación y exportación de API/ Exportación de las API
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Exportación de las API

Función

Esta API se utiliza para exportar las API en un grupo de API especificado. El contenido del archivo exportado cumple con el estándar Swagger. Para obtener detalles sobre los campos extendidos personalizados de APIG, véase la sección "Importación y exportación de API" > "Definición extendida" en la Guía de usuario del API Gateway.

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}/openapi/export

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.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

oas_version

No

String

Abrir la versión de API.

Predeterminado: 2.0

Parámetros de solicitud

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

Parámetro

Obligatorio

Tipo

Descripción

env_id

Sí

String

ID del entorno en el que se han publicado las API de un grupo.

group_id

Sí

String

ID de grupo de API.

define

No

String

Ámbito de definición de las API que se van a exportar:

  • spec: definiciones básicas, incluidas solo las definiciones frontend.

  • proxy: definiciones completas, incluidas las definiciones frontend y backend.

  • all: definiciones extendidas, incluidas las definiciones frontend y backend, así como políticas de limitación de solicitudes, políticas de control de acceso y autorizados personalizados.

  • dev: definiciones de desarrollo, incluidas las definiciones frontend y backend de las API que no se han publicado.

Predeterminado: spec

type

No

String

Formato para exportar definiciones de API.

Predeterminado: json

version

No

String

Número de versión de las API después de exportar. El valor predeterminado es la fecha y hora actuales.

apis

No

Array of strings

ID de las API que se van a exportar.

Parámetros de respuesta

Código de estado: 200

Tabla 5 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

-

File

-

Código de estado: 400

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: 401

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: 403

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: 404

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.

Código de estado: 500

Tabla 10 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

Exportación de las API

{
  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "define" : "all"
}

Ejemplo de respuestas

Código de estado: 400

Error en la solicitud

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified,parameterName:env_id. 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.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 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

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.