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/ Las API de gateway dedicado (V2)/ Importación y exportación de API/ Exportación de APIs
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Exportación de APIs

Función

Esta API se utiliza para exportar API en un grupo de API especificado. El contenido del archivo exportado cumple con el estándar Swagger. Para obtener más información sobre los campos extendidos personalizados de APIG, consulte la sección "Importación y exportación de API: definición extendida" en la Guía para desarrolladores.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export

Tabla 1 Parámetros de path

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

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 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.
Tabla 3 Parámetros de body 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

Valores de enumeración:

  • spec

  • proxy

  • all

  • dev

type

No

String

Formato para exportar definiciones de API.

Predeterminado: json

Valores de enumeración:

  • json

  • yaml

  • yml

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

Tabla 4 Parámetros de body 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 5 Parámetros de body 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 6 Parámetros de body 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 7 Parámetros de body 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 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

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

Ejemplo de respuestas

Código de estado: 400

Bad Request

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

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.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.