Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/API Gateway/Referência de API/APIs de gateway dedicadas (V2)/Importação e exportação de API/Exportação de APIs
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Exportação de APIs

Função

Esta API é usada para exportar APIs em um grupo de APIs especificado. O conteúdo do arquivo exportado está em conformidade com o padrão Swagger. Para obter detalhes sobre os campos estendidos personalizados do APIG, consulte a seção "Importação e exportação de APIs: definição estendida" no Guia de desenvolvedor.

URI

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

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.

Parâmetros de solicitação

Tabela 2 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Tabela 3 Parâmetros de corpo de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

env_id

Sim

String

ID do ambiente no qual as APIs de um grupo foram publicadas.

group_id

Sim

String

ID do grupo da API.

define

Não

String

Definição do escopo das APIs a serem exportadas:

  • spec: definições básicas, incluindo apenas as definições de front-end.

  • proxy: definições completas, incluindo as definições de front-end e back-end.

  • all: definições estendidas, incluindo as definições de front-end e back-end, bem como políticas de limitação de solicitações, políticas de controle de acesso e autorizadores personalizados.

  • dev: definições de desenvolvimento, incluindo as definições de front-end e back-end de APIs que não foram publicadas.

Padrão: spec

Valores de enumeração:

  • spec

  • proxy

  • all

  • dev

type

Não

String

Formato para exportar definições de API.

Padrão: json

Valores de enumeração:

  • json

  • yaml

  • yml

version

Não

String

Número da versão das APIs após a exportação. O valor padrão é a data e a hora atuais.

apis

Não

Array of strings

IDs das APIs a serem exportados.

Parâmetros de resposta

Código de status: 400

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 401

Tabela 5 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 403

Tabela 6 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 404

Tabela 7 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 8 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitações

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

Exemplo de respostas

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified,parameterName:env_id. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.