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.
Computação
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Redes
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Gerenciamento e governança
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
Cloud Operations Center
Resource Governance Center
Migração
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Análises
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
IoT
IoT Device Access
Outros
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Segurança e conformidade
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Blockchain
Blockchain Service
Serviços de mídia
Media Processing Center
Video On Demand
Live
SparkRTC
Armazenamento
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Cloud Server Backup Service
Storage Disaster Recovery Service
Scalable File Service
Volume Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Bancos de dados
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Aplicações de negócios
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Data Lake Factory
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Distribuição de conteúdo e computação de borda
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Soluções
SAP Cloud
High Performance Computing
Serviços para desenvolvedore
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
Cloud Application Engine
MacroVerse aPaaS
KooPhone
KooDrive
Central de ajuda/ API Gateway/ Guia de usuário/ Gerenciamento de API/ Criação de uma resposta de gateway

Criação de uma resposta de gateway

Atualizado em 2024-10-14 GMT+08:00

Uma resposta de gateway é exibida se o APIG falhar ao processar uma solicitação de API. O APIG fornece um conjunto de respostas padrão e também permite que você crie respostas com códigos de status e conteúdo personalizados. O conteúdo da resposta deve estar no formato JSON.

Por exemplo, o conteúdo de uma resposta de gateway padrão é o seguinte:

{"error_code": "$context.error.code", "error_msg": "$context.error.message", "request_id": "$context.requestId"}

Você pode adicionar uma resposta com o seguinte conteúdo:

{"errorcode": "$context.error.code", "errormsg": "$context.error.message", "requestid": "$context.requestId","apiId":"$context.apiId"}

Você pode adicionar mais campos ao corpo JSON ou excluir campos existentes do corpo JSON.

  • Você pode criar um máximo de quatro respostas de gateway para cada grupo.
  • Um máximo de 10 cabeçalhos de resposta podem ser personalizados. A chave de um cabeçalho de resposta pode conter de 1 a 128 caracteres, incluindo dígitos, letras e sublinhados (_). O valor pode fazer referência a variáveis de tempo de execução (consulte Variáveis de contexto), mas não pode conter colchetes duplos ([[ ou ]]).
  • O tipo de uma resposta padrão ou personalizada não pode ser modificado, mas o código de status e o conteúdo da resposta podem.
  • O tipo de resposta de gateway não pode ser alterado. Para mais detalhes, consulte Tipos de respostas.
  • As respostas do gateway podem conter as variáveis de contexto do gateway de API (começando com $context). Para mais detalhes, consulte Variáveis de contexto.

Procedimento

  1. Vá para o console do APIG.
  1. Selecione um gateway dedicado na parte superior do painel de navegação.
  1. Escolha API Management > API Groups.
  1. Clique em um nome de grupo.
  2. Clique na guia Group Information.
  3. Na área Gateway Responses, crie ou modifique as respostas do gateway.

    Para cancelar modificações em uma resposta padrão, clique em Restore Defaults no canto superior direito.

Tipos de respostas

A tabela a seguir lista os tipos de respostas suportados pelo APIG. Você pode definir códigos de status para atender aos seus requisitos de serviço.

Tabela 1 Tipos de resposta de erro suportados pelo APIG

Nome da resposta

Código de status padrão

Descrição

Access Denied

403

Acesso negado. Por exemplo, a política de controle de acesso é acionada ou um ataque é detectado.

Authorizer Configuration Error

500

Ocorreu um erro de autorizador personalizado. Por exemplo, a comunicação falhou ou uma resposta de erro foi retornada.

Authorizer Failed

500

Falha na autorização personalizada.

Incorrect Identity Source

401

A origem de identidade do autorizador personalizado está ausente ou é inválida.

Third-Party Configuration Error

500

Ocorreu um erro de autorizador de terceiros. Por exemplo, a comunicação falhou ou uma resposta de erro foi retornada.

Third-Party Authorizer Failure

401

O autorizador de terceiros retorna uma falha de autenticação.

Incorrect Third-Party Identity Source

401

A fonte de identidade do autorizador de terceiros está ausente.

Authentication Failure

401

Falha na autenticação do IAM ou da aplicação.

Identity Source Not Found

401

Nenhuma fonte de identidade foi especificada.

Backend Timeout

504

A comunicação com o serviço de back-end atingiu o tempo limite.

Backend Unavailable

502

O serviço de back-end não está disponível devido a um erro de comunicação.

Default 4XX

-

Outro erro 4XX ocorreu.

Default 5XX

-

Outro erro 5XX ocorreu.

No API Found

404

Nenhuma API foi encontrada.

Incorrect Request Parameters

400

Os parâmetros de solicitação estão incorretos ou o método HTTP não é suportado.

Request Throttled

429

A solicitação foi rejeitada devido à limitação de solicitação.

Unauthorized Credential

401

A credencial que você está usando não foi autorizada a chamar a API.

Variáveis de contexto

Tabela 2 Variáveis que podem ser usadas no corpo da mensagem de resposta

Variável

Descrição

$context.apiId

ID da API.

$context.apiName

Nome da API.

$context.appId

ID da credencial que chama a API.

$context.appName

Nome da credencial que chama a API.

$context.requestId

ID da solicitação gerado quando a API é chamada.

$context.stage

Ambiente de implementação no qual a API é chamada.

$context.sourceIp

Endereço IP de origem do chamador da API.

$context.reqPath

Caminho de solicitação de API, excluindo a cadeia de consulta.

$context.reqUri

Caminho de solicitação da API, incluindo a cadeia de consulta.

$context.reqMethod

Método de solicitação.

$context.authorizer.frontend.property

Valores dos pares atributo-valor especificados mapeados para o contexto na resposta do autorizador personalizada de front-end.

$context.authorizer.backend.property

Valores dos pares atributo-valor especificados mapeados para o contexto na resposta do autorizador personalizada de back-end.

$context.error.message

Mensagem de erro.

$context.error.code

Código de erro.

$context.error.type

Tipo de erro.

Usamos cookies para aprimorar nosso site e sua experiência. Ao continuar a navegar em nosso site, você aceita nossa política de cookies. Saiba mais

Feedback

Feedback

Feedback

0/500

Conteúdo selecionado

Envie o conteúdo selecionado com o feedback