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.
API Gateway
API Gateway
- Visão geral de serviço
- Primeiros passos
-
Guia de usuário
- Visão geral
-
Gerenciamento de API
- Criação de um grupo de APIs
- Importação de uma carga de trabalho do CCE
- Vinculação de um nome de domínio
- Criação de uma variável de ambiente
- Criação de uma resposta de gateway
- Criação de uma API
- Criação de uma API de gRPC
- Clonagem de uma API
- CORS
- Depuração de uma API
- Autorização de acesso à API
- Publicação de uma API
- Colocar uma API off-line
-
Importação e exportação de APIs
- Restrições e compatibilidade
- Importação de APIs
- Exportação de APIs
-
Definição estendida
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- Visualização de APIs
- HTTP 2.0
-
Políticas da API
- Criar uma política e vinculá-la a APIs
- CORS
- Gerenciamento de cabeçalho de resposta HTTP
- Limitação de solicitação 2.0
- Push de log do Kafka
- Disjuntor
- Autorizador de terceiros
- Limitação de solicitação
- Controle de acesso
- Chaves de assinatura
- Autorizadores personalizados
- Certificados SSL
- Canais de balanceamento de carga
- Gerenciamento de ambientes
- Credenciais
- Monitoramento e análise
- Gerenciamento de gateway
- SDKs
- Chamada de API publicada
- Gerenciamento de permissões
-
Console antigo
- Visão geral
- Gerenciamento de gateway
- Abertura da API
- Chamada de API
- Gerenciamento de permissões
- Principais operações gravadas pelo CTS
-
Melhores práticas
- Exposição seletiva de cargas de trabalho do CCE com um gateway dedicado
- Exposição seletiva dos recursos de serviço de um data center usando um gateway dedicado
- Desenvolvimento de um autorizador personalizado com FunctionGraph
- Exposição de serviços de back-end entre VPCs usando um gateway dedicado
- Interconexão de um gateway dedicado com o WAF
- Limitação de solicitações 2.0 com um gateway dedicado
- Autenticação de dois fatores com um gateway dedicado
- Redirecionamento automático de HTTP para HTTPS com um gateway dedicado
- Roteamento de solicitações de serviço gRPC usando um gateway dedicado
- Autenticação de cliente com um gateway dedicado
-
Referência de API
- Antes de começar
- Visão geral de API
- Chamada das APIs
- Primeiros passos
-
APIs compartilhadas de gateway (para usuários existentes)
- Gerenciamento de grupos de API
-
Gerenciamento de API
- Modelo de objeto
- Registro de uma API
- Modificação de uma API
- Exclusão de uma API
- Publicação de uma API
- Colocar uma API off-line
- Publicação de várias APIs ou colocação de várias APIs off-line
- Consulta de detalhes da API
- Consulta de uma lista de APIs
- Consulta de versões históricas da API
- Colocação de uma versão efetiva de uma API off-line
- Consulta de detalhes de uma versão da API
- Consulta da definição de tempo de execução de uma API
- Depuração de uma API
-
Gerenciamento de aplicações
- Modelo de objeto
- Criação de uma aplicação
- Modificação de uma aplicação
- Redefinição de um AppSecret
- Exclusão de uma aplicação
- Verificação de uma aplicação
- Consulta de detalhes da aplicação
- Consulta de uma lista de aplicações
- Criação de um AppCode
- Geração de um AppCode
- Consulta de detalhes do AppCode
- Consulta de uma lista de AppCode
- Exclusão de um AppCode
- Gerenciamento de autorização de aplicações
- Gerenciamento de ambiente
- Gerenciamento de variáveis de ambiente
-
Gerenciamento de política de limitação de solicitação
- Modelo de objeto
- Criação de uma política de limitação de solicitações
- Modificação de uma política de limitação de solicitação
- Exclusão de uma política de limitação de solicitação
- Consulta de detalhes de uma política de limitação de solicitações
- Consulta da lista de políticas de limitação de solicitação
-
Políticas de limitação de solicitação de vinculação
- Modelo de objeto
- Consulta da lista de APIs não vinculadas a uma política de limitação de solicitações
- Vinculação de uma política de limitação de solicitação
- Consulta da lista de APIs vinculadas a uma política de limitação de solicitações
- Consulta da lista de políticas de limitação de solicitações vinculadas a uma API
- Desvinculação de uma política de limitação de solicitações
- Configuração de limitação de solicitação excluída
-
Gerenciamento de política de controle de acesso
- Modelo de objeto
- Criação de uma política de controle de acesso
- Modificação de uma política de controle de acesso
- Exclusão de uma política de controle de acesso
- Exclusão de várias políticas de controle de acesso
- Consulta de detalhes de uma política de controle de acesso
- Consulta da lista de políticas de controle de acesso
-
Vinculação de políticas de controle de acesso
- Modelo de objeto
- Vinculação de uma política de controle de acesso a uma API
- Consulta da lista de políticas de controle de acesso vinculadas a uma API
- Consulta da lista de APIs vinculadas a uma política de controle de acesso
- Consulta da lista de APIs não vinculadas a uma política de controle de acesso
- Desvinculação de uma política de controle de acesso de uma API
- Desvinculação de várias políticas de controle de acesso de APIs
- Consulta de informações de assinatura no marketplace
- Gerenciamento da configuração
- Consulta de recursos
- Gerenciamento de chaves de assinatura
- Vinculação de chaves de assinatura
- Gerenciamento de nome de domínio
-
Gerenciamento de canais da VPC
- Modelo de objeto
- Criação de um canal da VPC
- Atualização de um canal da VPC
- Exclusão de um canal da VPC
- Consulta de detalhes do canal da VPC
- Consulta da lista de canais da VPC
- Adição de instâncias de back-end (servidores em nuvem)
- Exclusão de uma instância de back-end (servidor em nuvem)
- Consulta da lista de instâncias de back-end (lista de servidores em nuvem)
- Consulta de métricas
- OpenAPI
- Gerenciamento de autorizador personalizado
-
APIs de gateway dedicadas (V2)
- Gerenciamento de grupos de APIs
- Gerenciamento de ambiente
- Gerenciamento de variáveis de ambiente
- Gerenciamento de política de limitação de solicitação
-
Gerenciamento de API
- Registração de uma API
- Modificação de uma API
- Exclusão de uma API
- Publicar uma API ou deixar uma API off-line
- Consulta de detalhes da API
- Consulta de APIs
- Depuração de uma API
- Publicar APIs ou deixar APIs off-line
- Consulta de versões históricas de uma API
- Alternação da versão de uma API
- Consulta da definição de tempo de execução de uma API
- Consulta de detalhes da versão de API
- Deixar uma versão da API off-line
- Gerenciamento de chaves de assinatura
- Vinculação/desvinculação de chaves de assinatura
-
Vinculação/desvinculação de políticas de limitação de solicitações
- Vinculação de uma política de limitação de solicitação
- Desvinculação de uma política de limitação de solicitação
- Consulta de APIs vinculadas a uma política de limitação de solicitações
- Consulta de APIs não vinculadas com uma política de limitação de solicitações
- Consulta de políticas de limitação de solicitação vinculadas a uma API
- Desvinculação de políticas de limitação de solicitação
- Configuração de limitação de solicitação excluída
- Gerenciamento de autorização de aplicações
- Consulta de recursos
-
Gerenciamento de aplicações
- Criação de uma aplicação
- Modificação de uma aplicação
- Exclusão de uma aplicação
- Redefinição do AppSecret de uma aplicação
- Verificação de uma aplicação
- Consulta de detalhes da aplicação
- Consulta de aplicação
- Criação de um AppCode
- Geração de um AppCode
- Exclusão de um AppCode
- Consulta de detalhes do AppCode
- Consulta de AppCodes de uma aplicação
- Gerenciamento de nome de domínio
- Gerenciamento de política de controle de acesso
-
Vinculação/desvinculação de políticas de controle de acesso
- Vinculação de uma política de controle de acesso a uma API
- Desvinculação de uma política de controle de acesso
- Desvinculação de políticas de controle de acesso
- Consulta de APIs vinculadas com uma política de controle de acesso
- Consulta de APIs não vinculadas a uma política de controle de acesso
- Consulta de políticas de controle de acesso vinculadas a uma API
- Gerenciamento de autorizador personalizado
- Importação e exportação de API
-
Gerenciamento de canais da VPC
- Criação de um canal da VPC
- Atualização de um canal da VPC
- Exclusão de um canal da VPC
- Consulta de detalhes do canal da VPC
- Consulta de canais da VPC
- Adição ou atualização de instâncias de back-end
- Consulta de servidores de back-end de um canal da VPC
- Atualização de instâncias de back-end
- Remoção de um servidor back-end
- Habilitação de servidores back-end
- Desativação de servidores back-end
- Modificação da verificação de integridade do canal da VPC
- Adição ou atualização de um grupo de servidores back-end de um canal da VPC
- Consulta de grupos de servidores back-end de um canal da VPC
- Consulta de um grupo de servidores back-end de um canal da VPC
- Exclusão de um grupo de servidores back-end de um canal da VPC
- Atualização de um grupo de servidores back-end de um canal da VPC
- Monitoramento de consultas de informação
- Gerenciamento de resposta de grupo
- Gerenciamento de tags
- Gerenciamento de recursos de gateway
- Gerenciamento da configuração
-
Gerenciamento de gateway
- Criação de um gateway dedicado
- Consulta de detalhes do gateway dedicado
- Atualização de um gateway dedicado
- Consulta do progresso de criação de um gateway dedicado
- Atualização ou vinculação de um EIP a um gateway dedicado
- Desvinculação do EIP de um gateway dedicado
- Habilitação do acesso público para um gateway dedicado
- Atualização da largura de banda de acesso de saída de um gateway dedicado
- Desabilitação do acesso público para um gateway dedicado
- Consulta de AZs
- Consulta de gateways dedicados
- Exclusão de um gateway dedicado
- Políticas de permissões e ações suportadas
- Apêndice
- História de mudanças
-
Perguntas frequentes
- Perguntas frequentes comuns
-
Criação de API
- Por que não consigo criar APIs?
- Como definir códigos de resposta para uma API?
- Como especificar a porta do host para um canal de VPC (ou canal de balanceamento de carga)?
- Como definir o endereço de back-end se não for usar um canal de VPC (ou um canal de balanceamento de carga)?
- Como configurar o endereço do serviço de back-end?
- Posso especificar um endereço de balanceador de carga de rede privada para o serviço de back-end?
- Posso especificar o endereço de back-end como um endereço IP de sub-rede?
- O APIG oferece suporte a vários pontos de extremidade de back-end?
- O que devo fazer depois de solicitar um nome de domínio independente?
- Posso vincular nomes de domínio privados para acesso à API?
- Por que uma API não pode ser chamada entre domínios?
-
Chamada de API
- Quais são as possíveis causas para uma falha de chamada de API?
- O que devo fazer se um código de erro for retornado durante a chamada da API?
- Por que estou vendo a mensagem de erro "414 Request-URI Too Large" quando chamo uma API?
- O que devo fazer se a mensagem "The API does not exist or has not been published in the environment." é exibida?
- Por que estou vendo a mensagem "No backend available"?
- Quais são as possíveis causas se a mensagem "Backend unavailable" ou "Backend timeout" for exibida?
- Por que estou vendo a mensagem "Backend domain name resolution failed" quando um serviço de back-end é chamado?
- Por que a modificação do parâmetro backend_timeout não tem efeito?
- Como alternar o ambiente para chamada de API?
- Qual é o tamanho máximo de um pacote de solicitação de API?
- Como executar a autenticação de aplicações no sistema iOS?
- Por que não posso criar um parâmetro de cabeçalho chamado x-auth-token para uma API chamada por meio da autenticação do IAM?
- Perguntas frequentes sobre credencial
- Aplicações de móveis podem chamar APIs?
- As aplicações implementadas em uma VPC podem chamar APIs?
- Como implementar a transmissão de dados de WebSocket?
- O APIG oferece suporte a conexões persistentes?
- Como as solicitações para uma API com várias políticas de back-end serão correspondidas e executadas?
- Existe um limite no tamanho da resposta a uma solicitação de API?
- Como acessar serviços de back-end em redes públicas através do APIG?
-
Autenticação da API
- O APIG oferece suporte à autenticação bidirecional HTTPS?
- Como chamar uma API que não requer autenticação?
- Quais versões de TLS o APIG suporta?
- O APIG suporta autenticação personalizada?
- O corpo de solicitação será assinado para autenticação de segurança?
- Erros comuns relacionados às informações de autenticação do IAM
- Políticas de controle da API
- Publicação de API
- Importação e exportação de API
- Segurança da API
-
Outras perguntas frequentes
- Quais são as relações entre uma API, um ambiente e uma credencial?
- Como usar o APIG?
- Quais linguagens de SDK o APIG suporta?
- Posso fazer upload de arquivos usando o método POST?
- Como são as mensagens de erro retornadas pelo APIG?
- Como usar o APIG para abrir os serviços implementados na Huawei Cloud?
- Posso atualizar o gateway compartilhado para um gateway dedicado?
- Por que todos os botões no console do APIG estão indisponíveis?
- O APIG pode ser implementado em um data center local?
- No momento, o conteúdo não está disponível no seu idioma selecionado. Consulte a versão em inglês.
- What's New
- Function Overview
- Product Bulletin
- Billing
- Developer Guide
- SDK Reference
- Videos
-
More Documents
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Getting Started
- Comparing Versions
- Overview
-
API Management
- Creating an API Group
- Binding a Domain Name
- Creating an Environment Variable
- Creating a Gateway Response
- Creating an API
- Cloning an API
- CORS
- Debugging an API
- Authorizing API Access
- Publishing an API
- Taking an API Offline
-
Importing and Exorting APIs
- Restrictions and Compatibility
- Importing APIs
- Exporting APIs
-
Extended Definition
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- Viewing APIs
- HTTP 2.0
- API Policies
- Credentials
- Monitoring & Analysis
- Gateway Management
- SDKs
- Published API Calling
- Permissions Management
- Auditing
-
FAQs
- Common FAQs
-
API Creation
- How Do I Define Response Codes for an API?
- How Do I Specify the Host Port for a VPC Channel (or Load Balance Channel)?
- How Do I Set the Backend Address If I Will Not Use a VPC Channel (or Load Balance Channel)?
- How Can I Configure the Backend Service Address?
- Can I Specify a Private Network Load Balancer Address for the Backend Service?
- Can I Specify the Backend Address as a Subnet IP Address?
- Does APIG Support Multiple Backend Endpoints?
- What Should I Do After Applying for an Independent Domain Name?
- Can I Bind Private Domain Names for API Access?
- Why Does an API Failed to Be Called Across Domains?
-
API Calling
- What Are the Possible Causes for an API Calling Failure?
- What Should I Do If an Error Code Is Returned During API Calling?
- Why Am I Seeing the Error Message "414 Request URI too large" When I Call an API?
- What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?
- Why Am I Seeing the Message "No backend available"?
- What Are the Possible Causes If the Message "Backend unavailable" or "Backend timeout" Is Displayed?
- Why Am I Seeing the Message "Backend domain name resolution failed" When a Backend Service Is Called?
- Why Doesn't Modification of the backend_timeout Parameter Take Effect?
- How Do I Switch the Environment for API Calling?
- What Is the Maximum Size of an API Request Package?
- How Do I Perform App Authentication in iOS System?
- Why Can't I Create a Header Parameter Named x-auth-token for an API Called Through IAM Authentication?
- App (Credential) FAQs
- Can Mobile Apps Call APIs?
- Can Applications Deployed in a VPC Call APIs?
- Does APIG Support WebSocket Data Transmission?
- Does APIG Support Persistent Connections?
- How Will the Requests for an API with Multiple Backend Policies Be Matched and Executed?
- Is There a Limit on the Size of the Response to an API Request?
- How Can I Access Backend Services over Public Networks Through APIG?
-
API Authentication
- Does APIG Support HTTPS Two-Way Authentication?
- How Do I Call an API That Does Not Require Authentication?
- Which TLS Versions Does APIG Support?
- Does APIG Support Custom Authentication?
- Will the Request Body Be Signed for Security Authentication?
- Common Errors Related to IAM Authentication Information
- What Should I Do If the App Authentication Information Is Incorrect?
- API Control Policies
- API Publishing
- API Import and Export
- API Security
- Other FAQs
- Change History
- Developer Guide (Kuala Lumpur Region)
-
API Reference (Kuala Lumpur Region)
- Before You Start
- Calling APIs
-
Dedicated Gateway APIs (V2)
- API Group Management
- Environment Management
- Environment Variable Management
- Request Throttling Policy Management
-
API Management
- Creating an API
- Modifying an API
- Deleting an API
- Publishing an API or Taking an API Offline
- Querying API Details
- Querying APIs
- Verifying the API Definition
- Debugging an API
- Publishing APIs or Taking APIs Offline
- Querying Historical Versions of an API
- Switching the Version of an API
- Querying the Runtime Definition of an API
- Querying API Version Details
- Taking an API Version Offline
- Signature Key Management
- Binding/Unbinding Signature Keys
- Binding/Unbinding Request Throttling Policies
- Excluded Request Throttling Configuration
- App Authorization Management
- Resource Query
- Domain Name Management
- Access Control Policy Management
- Binding/Unbinding Access Control Policies
- Custom Authorizer Management
- API Import and Export
-
VPC Channel Management
- Creating a VPC Channel
- Updating a VPC Channel
- Deleting a VPC Channel
- Querying VPC Channel Details
- Querying VPC Channels
- Adding or Updating Backend Instances
- Querying Backend Servers of a VPC Channel
- Updating Backend Instances
- Removing a Backend Server
- Enabling Backend Servers
- Disabling Backend Servers
- Modifying VPC Channel Health Check
- Adding or Updating a Backend Server Group of a VPC Channel
- Querying Backend Server Groups of a VPC Channel
- Querying a Backend Server Group of a VPC Channel
- Deleting a Backend Server Group of a VPC Channel
- Updating a Backend Server Group of a VPC Channel
- Monitoring Information Query
- Group Response Management
- Tag Management
- Gateway Feature Management
- Configuration Management
-
Gateway Management
- Creating a Dedicated Gateway (Pay-Per-Use)
- Querying Dedicated Gateway Details
- Updating a Dedicated Gateway
- Querying the Creation Progress of a Dedicated Gateway
- Updating or Binding an EIP to a Dedicated Gateway
- Unbinding the EIP of a Dedicated Gateway
- Enabling Public Access for a Dedicated Gateway
- Updating the Outbound Access Bandwidth of a Dedicated Gateway
- Disabling Public Access for a Dedicated Gateway
- Enabling Public Inbound Access
- Updating Public Inbound Access Bandwidth of a Gateway
- Disabling Public Inbound Access for a Gateway
- Querying AZs
- Querying Dedicated Gateways
- Deleting a Dedicated Gateway
- Modifying the Specifications of a Pay-Per-Use Gateway
- Querying Gateway Constraints
- VPC Endpoint Management
- Gateway Tag Management
-
SSL Certificate Management
- Querying SSL Certificates
- Creating an SSL Certificate
- Binding a Domain Name with SSL Certificates
- Unbinding a Domain Name's SSL Certificates
- Querying Certificate Details
- Deleting an SSL Certificate
- Modifying an SSL Certificate
- Binding an SSL Certificate to a Domain Name
- Unbinding an SSL Certificate from a Domain Name
- Querying Domain Names of an SSL Certificate
-
Plug-in Management
- Creating a Plug-in
- Modifying a Plug-in
- Deleting a Plug-in
- Querying Plug-ins
- Querying Plug-in Details
- Binding a Plug-in to APIs
- Binding an API with Plug-ins
- Unbinding a Plug-in from All APIs
- Unbinding an API's Plug-ins
- Querying APIs Bound with a Plug-in
- Querying Plug-ins Bound to an API
- Querying APIs to Which a Plug-in Can Be Bound
- Querying Plug-ins That Can Be Bound to an API
-
Credential Management
- Creating an App
- Modifying an App
- Deleting an App
- Resetting the AppSecret of an App
- Verifying an App
- Querying App Details
- Querying Apps
- Creating an AppCode
- Generating an AppCode
- Deleting an AppCode
- Querying AppCode Details
- Querying AppCodes of an App
- Querying Quotas Associated with a Credential
- Configuring Access Control Settings for an App
- Querying Access Control Details About an App
- Deleting Access Control Settings of an App
-
Credential Quota Management
- Creating a Credential Quota
- Querying Credential Quota Details
- Querying Credential Quotas
- Modifying a Credential Quota
- Deleting a Credential Quota
- Querying the Credentials Bound to a Specified Quota
- Binding a Credential Quota with Credentials
- Unbinding a Credential Quota from a Credential
- Querying Credentials That Can Be Bound to a Credential Quota
- Asynchronous Task Management
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Comparing Versions
- Overview
-
API Management
- Creating an API Group
- Importing a CCE Workload
- Binding a Domain Name
- Creating an Environment Variable
- Creating a Gateway Response
- Creating an API
- Creating a gRPC API
- Cloning an API
- CORS
- Debugging an API
- Authorizing API Access
- Publishing an API
- Taking an API Offline
-
Importing and Exorting APIs
- Restrictions and Compatibility
- Importing APIs
- Exporting APIs
-
Extended Definition
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- Viewing APIs
- HTTP 2.0
- API Policies
- Credentials
- Monitoring & Analysis
- Gateway Management
- SDKs
- Published API Calling
- Permissions Management
- Auditing
-
FAQs
- Common FAQs
-
API Creation
- Why Can't I Create APIs?
- How Do I Define Response Codes for an API?
- How Do I Specify the Host Port for a VPC Channel (or Load Balance Channel)?
- How Do I Set the Backend Address If I Will Not Use a VPC Channel (or Load Balance Channel)?
- How Can I Configure the Backend Service Address?
- Can I Specify a Private Network Load Balancer Address for the Backend Service?
- Can I Specify the Backend Address as a Subnet IP Address?
- Does APIG Support Multiple Backend Endpoints?
- What Should I Do After Applying for an Independent Domain Name?
- Can I Bind Private Domain Names for API Access?
- Why Does an API Failed to Be Called Across Domains?
-
API Calling
- What Are the Possible Causes for an API Calling Failure?
- What Should I Do If an Error Code Is Returned During API Calling?
- Why Am I Seeing the Error Message "414 Request URI too large" When I Call an API?
- What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?
- Why Am I Seeing the Message "No backend available"?
- What Are the Possible Causes If the Message "Backend unavailable" or "Backend timeout" Is Displayed?
- Why Am I Seeing the Message "Backend domain name resolution failed" When a Backend Service Is Called?
- Why Doesn't Modification of the backend_timeout Parameter Take Effect?
- How Do I Switch the Environment for API Calling?
- What Is the Maximum Size of an API Request Package?
- How Do I Perform App Authentication in iOS System?
- Why Can't I Create a Header Parameter Named x-auth-token for an API Called Through IAM Authentication?
- App (Credential) FAQs
- Can Mobile Apps Call APIs?
- Can Applications Deployed in a VPC Call APIs?
- Does APIG Support WebSocket Data Transmission?
- Does APIG Support Persistent Connections?
- How Will the Requests for an API with Multiple Backend Policies Be Matched and Executed?
- Is There a Limit on the Size of the Response to an API Request?
- How Can I Access Backend Services over Public Networks Through APIG?
-
API Authentication
- Does APIG Support HTTPS Two-Way Authentication?
- How Do I Call an API That Does Not Require Authentication?
- Which TLS Versions Does APIG Support?
- Does APIG Support Custom Authentication?
- Will the Request Body Be Signed for Security Authentication?
- Common Errors Related to IAM Authentication Information
- What Should I Do If the App Authentication Information Is Incorrect?
- API Control Policies
- API Publishing
- API Import and Export
- API Security
- Other FAQs
- Change History
- Developer Guide (ME-Abu Dhabi Region)
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- Calling APIs
-
Dedicated Gateway APIs (V2)
- API Group Management
- Environment Management
- Environment Variable Management
- Request Throttling Policy Management
-
API Management
- Creating an API
- Modifying an API
- Deleting an API
- Publishing an API or Taking an API Offline
- Querying API Details
- Querying APIs
- Verifying the API Definition
- Debugging an API
- Publishing APIs or Taking APIs Offline
- Querying Historical Versions of an API
- Switching the Version of an API
- Querying the Runtime Definition of an API
- Querying API Version Details
- Taking an API Version Offline
- Signature Key Management
- Binding/Unbinding Signature Keys
- Binding/Unbinding Request Throttling Policies
- Excluded Request Throttling Configuration
- App Authorization Management
- Resource Query
- Domain Name Management
- Access Control Policy Management
- Binding/Unbinding Access Control Policies
- Custom Authorizer Management
- API Import and Export
-
VPC Channel Management
- Creating a VPC Channel
- Updating a VPC Channel
- Deleting a VPC Channel
- Querying VPC Channel Details
- Querying VPC Channels
- Adding or Updating Backend Instances
- Querying Backend Servers of a VPC Channel
- Updating Backend Instances
- Removing a Backend Server
- Enabling Backend Servers
- Disabling Backend Servers
- Modifying VPC Channel Health Check
- Adding or Updating a Backend Server Group of a VPC Channel
- Querying Backend Server Groups of a VPC Channel
- Querying a Backend Server Group of a VPC Channel
- Deleting a Backend Server Group of a VPC Channel
- Updating a Backend Server Group of a VPC Channel
- Monitoring Information Query
- Group Response Management
- Tag Management
- Gateway Feature Management
- Configuration Management
-
Gateway Management
- Creating a Dedicated Gateway (Pay-Per-Use)
- Querying Dedicated Gateway Details
- Updating a Dedicated Gateway
- Querying the Creation Progress of a Dedicated Gateway
- Updating or Binding an EIP to a Dedicated Gateway
- Unbinding the EIP of a Dedicated Gateway
- Enabling Public Access for a Dedicated Gateway
- Updating the Outbound Access Bandwidth of a Dedicated Gateway
- Disabling Public Access for a Dedicated Gateway
- Enabling Public Inbound Access
- Updating Public Inbound Access Bandwidth of a Gateway
- Disabling Public Inbound Access for a Gateway
- Querying AZs
- Querying Dedicated Gateways
- Deleting a Dedicated Gateway
- Modifying the Specifications of a Pay-Per-Use Gateway
- Querying Gateway Constraints
- VPC Endpoint Management
- Gateway Tag Management
- Microservice Center Management
-
SSL Certificate Management
- Querying SSL Certificates
- Creating an SSL Certificate
- Binding a Domain Name with SSL Certificates
- Unbinding a Domain Name's SSL Certificates
- Querying Certificate Details
- Deleting an SSL Certificate
- Modifying an SSL Certificate
- Binding an SSL Certificate to a Domain Name
- Unbinding an SSL Certificate from a Domain Name
- Querying Domain Names of an SSL Certificate
-
Plug-in Management
- Creating a Plug-in
- Modifying a Plug-in
- Deleting a Plug-in
- Querying Plug-ins
- Querying Plug-in Details
- Binding a Plug-in to APIs
- Binding an API with Plug-ins
- Unbinding a Plug-in from All APIs
- Unbinding an API's Plug-ins
- Querying APIs Bound with a Plug-in
- Querying Plug-ins Bound to an API
- Querying APIs to Which a Plug-in Can Be Bound
- Querying Plug-ins That Can Be Bound to an API
-
Credential Management
- Creating an App
- Modifying an App
- Deleting an App
- Resetting the AppSecret of an App
- Verifying an App
- Querying App Details
- Querying Apps
- Creating an AppCode
- Generating an AppCode
- Deleting an AppCode
- Querying AppCode Details
- Querying AppCodes of an App
- Querying Quotas Associated with a Credential
- Configuring Access Control Settings for an App
- Querying Access Control Details About an App
- Deleting Access Control Settings of an App
-
Credential Quota Management
- This API is used to creat a credential quota.
- Querying Credential Quota Details
- Querying Credential Quotas
- Modifying a Credential Quota
- Deleting a Credential Quota
- Querying the Credentials Bound to a Specified Quota
- Binding a Credential Quota with Credentials
- Unbinding a Credential Quota from a Credential
- Querying Credentials That Can Be Bound to a Credential Quota
- Asynchronous Task Management
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
Best Practices (ME-Abu Dhabi Region)
- Selectively Exposing CCE Workloads with a Dedicated Gateway
- Selectively Exposing Service Capabilities of a Data Center Using a Dedicated Gateway
- Developing a Custom Authorizer with FunctionGraph
- Exposing Backend Services Across VPCs Using a Dedicated Gateway
- Interconnecting a Dedicated Gateway with WAF
- Request Throttling 2.0 with a Dedicated Gateway
- Two-Factor Authentication with a Dedicated Gateway
- HTTP-to-HTTPS Auto Redirection with a Dedicated Gateway
- Client Authentication with a Dedicated Gateway
- Invoking an API Policy Backend via Frontend Authentication Parameters (System Parameter)
- Forwarding WebSocket Services Using Dedicated Gateway
- Change History
- User Guide (Paris Region)
-
Developer Guide (Paris Region)
- Application Scenarios
- Calling APIs Through App Authentication
- Calling APIs Through IAM Authentication
- Creating Signatures for Backend Requests
-
Importing and Exporting APIs
- Restrictions and Compatibility
- Extended Definition
- API Import Precautions
- Examples of Importing APIs
- API Export Precautions
- Change History
-
API Reference (Paris Region)
- Before You Start
- Calling APIs
- Getting Started
-
Shared Gateway APIs
- API Group Management
-
API Management
- Object Model
- Registering an API
- Modifying an API
- Deleting an API
- Publishing an API
- Taking an API Offline
- Publishing Multiple APIs or Taking Multiple APIs Offline
- Querying API Details
- Querying an API List
- Querying Historical API Versions
- Taking an Effective Version of an API Offline
- Querying Details of an API Version
- Querying the Runtime Definition of an API
- Debugging an API
- App Management
- App Authorization Management
- Environment Management
- Environment Variable Management
- Request Throttling Policy Management
- Binding Request Throttling Policies
- Excluded Request Throttling Configuration
- Access Control Policy Management
-
Binding Access Control Policies
- Object Model
- Binding an Access Control Policy to an API
- Querying the List of Access Control Policies Bound to an API
- Querying the List of APIs Bound to an Access Control Policy
- Querying the List of APIs Not Bound to an Access Control Policy
- Unbinding an Access Control Policy from an API
- Unbinding Multiple Access Control Policies from APIs
- Querying Subscription Information in the Marketplace
- Resource Query
- Signature Key Management
- Binding Signature Keys
- Domain Name Management
- VPC Channel Management
- OpenAPI
- Custom Authorizer Management
- Appendix
- Change History
-
Dedicated API Gateway User Guide (Paris Region)
- Service Overview
- Getting Started
- Comparing Versions
- Overview
-
API Management
- Creating an API Group
- Binding a Domain Name
- Creating an Environment Variable
- Creating a Gateway Response
- Creating an API
- CORS
- Debugging an API
- Authorizing API Access
- Publishing an API
- Taking an API Offline
-
Importing and Exorting APIs
- Restrictions and Compatibility
- Importing APIs
- Exporting APIs
-
Extended Definition
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- Viewing APIs
- API Policies
- Credentials
- Monitoring & Analysis
- Gateway Management
- Published API Calling
- Permissions Management
- Auditing
-
FAQs
- Common FAQs
-
API Creation
- How Do I Define Response Codes for an API?
- How Do I Specify the Host Port for a VPC Channel (or Load Balance Channel)?
- How Do I Set the Backend Address If I Will Not Use a VPC Channel (or Load Balance Channel)?
- How Can I Configure the Backend Service Address?
- Can I Specify a Private Network Load Balancer Address for the Backend Service?
- Can I Specify the Backend Address as a Subnet IP Address?
- Does APIG Support Multiple Backend Endpoints?
- What Should I Do After Applying for an Independent Domain Name?
- Can I Bind Private Domain Names for API Access?
- Why Does an API Failed to Be Called Across Domains?
-
API Calling
- What Are the Possible Causes for an API Calling Failure?
- What Should I Do If an Error Code Is Returned During API Calling?
- Why Am I Seeing the Error Message "414 Request URI too large" When I Call an API?
- What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?
- Why Am I Seeing the Message "No backend available"?
- What Are the Possible Causes If the Message "Backend unavailable" or "Backend timeout" Is Displayed?
- Why Am I Seeing the Message "Backend domain name resolution failed" When a Backend Service Is Called?
- Why Doesn't Modification of the backend_timeout Parameter Take Effect?
- How Do I Switch the Environment for API Calling?
- What Is the Maximum Size of an API Request Package?
- How Do I Perform App Authentication in iOS System?
- Why Can't I Create a Header Parameter Named x-auth-token for an API Called Through IAM Authentication?
- App (Credential) FAQs
- Can Mobile Apps Call APIs?
- Can Applications Deployed in a VPC Call APIs?
- Does APIG Support WebSocket Data Transmission?
- Does APIG Support Persistent Connections?
- How Will the Requests for an API with Multiple Backend Policies Be Matched and Executed?
- Is There a Limit on the Size of the Response to an API Request?
- How Can I Access Backend Services over Public Networks Through APIG?
-
API Authentication
- Does APIG Support HTTPS Two-Way Authentication?
- How Do I Call an API That Does Not Require Authentication?
- Which TLS Versions Does APIG Support?
- Does APIG Support Custom Authentication?
- Will the Request Body Be Signed for Security Authentication?
- Common Errors Related to IAM Authentication Information
- API Control Policies
- API Publishing
- API Import and Export
- API Security
- Other FAQs
- Change History
- Dedicated API Gateway Developer Guide (Paris Region)
-
Dedicated API Gateway API Reference (Paris Region)
- Before You Start
- Calling APIs
-
Dedicated Gateway APIs (V2)
- API Group Management
- Environment Management
- Environment Variable Management
- Request Throttling Policy Management
-
API Management
- Creating an API
- Modifying an API
- Deleting an API
- Publishing an API or Taking an API Offline
- Querying API Details
- Querying APIs
- Debugging an API
- Publishing APIs or Taking APIs Offline
- Querying Historical Versions of an API
- Switching the Version of an API
- Querying the Runtime Definition of an API
- Querying API Version Details
- Taking an API Version Offline
- Signature Key Management
- Binding/Unbinding Signature Keys
- Binding/Unbinding Request Throttling Policies
- Excluded Request Throttling Configuration
- App Authorization Management
- Resource Query
- App Management
- Domain Name Management
- Access Control Policy Management
- Binding/Unbinding Access Control Policies
- Custom Authorizer Management
- API Import and Export
- VPC Channel Management
- Monitoring Information Query
- Group Response Management
- Tag Management
- Gateway Feature Management
- Configuration Management
-
Gateway Management
- Creating a Dedicated Gateway (Pay-Per-Use)
- Querying Dedicated Gateway Details
- Updating a Dedicated Gateway
- Querying the Creation Progress of a Dedicated Gateway
- Updating or Binding an EIP to a Dedicated Gateway
- Unbinding the EIP of a Dedicated Gateway
- Enabling Public Access for a Dedicated Gateway
- Updating the Outbound Access Bandwidth of a Dedicated Gateway
- Disabling Public Access for a Dedicated Gateway
- Querying AZs
- Querying Dedicated Gateways
- Deleting a Dedicated Gateway
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
User Guide (Kuala Lumpur Region)
Nesta página
Copiado.
Conceitos básicos
Atualizado em 2023-03-08 GMT+08:00
API
Um conjunto de funções predefinidas que encapsula as capacidades da aplicação. Você pode criar APIs e torná-las acessíveis aos usuários.
Ao criar uma API, você precisa configurar as informações básicas e os caminhos de solicitação, parâmetros e protocolos de front-end e back-end.
Grupo de API
Uma coleção de APIs usadas para o mesmo serviço. Os grupos de API facilitam o gerenciamento da API.
Ambiente
Um estágio no ciclo de vida de uma API. Um ambiente, como teste de API ou ambiente de desenvolvimento, especifica o escopo de uso das APIs, facilitando o gerenciamento do ciclo de vida da API. A mesma API pode ser publicada em diferentes ambientes.
Para chamar uma API em diferentes ambientes, você precisa adicionar o parâmetro de cabeçalho x-stage à solicitação enviada para chamar a API. O valor deste parâmetro é um nome de ambiente.
Variável de ambiente
Uma variável que é gerenciável e específica para um ambiente. Você pode criar variáveis em ambientes diferentes para chamar diferentes serviços de back-end usando a mesma API.
Limitação de solicitação
Controla o número de vezes que as APIs podem ser chamadas por um usuário, uma credencial ou um endereço IP durante um período específico para proteger os serviços de back-end.
A limitação de solicitação pode ser precisa ao minuto e ao segundo.
Controle de acesso
As políticas de controle de acesso são uma das medidas de segurança fornecidas pelo API Gateway. Eles permitem ou negam acesso à API de endereços IP ou contas específicas.
Credencial
Uma entidade que solicita APIs. Uma credencial pode ser autorizada a acessar várias APIs e várias credenciais podem ser autorizadas a acessar a mesma API.
Chave de assinatura
Consiste em uma chave e um segredo, que são usados pelos serviços de back-end para verificar a identidade do API Gateway e garantir o acesso seguro.
Quando uma API vinculada a uma chave de assinatura é chamada, o API Gateway adiciona informações de assinatura às solicitações da API. O serviço de back-end da API assina as solicitações da mesma maneira e verifica a identidade do API Gateway, verificando se a assinatura é consistente com a do cabeçalho Authorization enviado pelo API Gateway.
Canal de balanceamento de carga
Um método usado para acessar serviços implementados em VPCs. Você pode expor seletivamente serviços de back-end implementados em VPCs a usuários de terceiros.
Autenticação personalizada
Um mecanismo definido com regras personalizadas para o API Gateway verificar a validade e a integridade das solicitações iniciadas pelos chamadores da API. O mecanismo também é usado para serviços de back-end para verificar as solicitações encaminhadas pelo API Gateway.
Os dois tipos de autenticação personalizada a seguir são fornecidos:
- Autenticação personalizada do front-end: um autorizador personalizado é configurado com uma função para autenticar solicitações de uma API.
- Autenticação personalizada de back-end: um autorizador personalizado pode ser configurado para autenticar solicitações para diferentes serviços de back-end, eliminando a necessidade de personalizar APIs para diferentes sistemas de autenticação e simplificando o desenvolvimento de APIs. Você só precisa criar um autorizador personalizado baseado em função no API Gateway para se conectar ao sistema de autenticação de back-end.
Autenticação simples
A autenticação simples facilita a resposta rápida para solicitações de API adicionando o parâmetro X-Apig-AppCode (cujo valor é um AppCode) ao cabeçalho da solicitação HTTP. O API Gateway verifica apenas o AppCode e não verifica a assinatura da solicitação.
Resposta do gateway
As respostas do gateway são retornadas se o API Gateway falhar ao processar solicitações de API. O API Gateway fornece respostas padrão para vários cenários e permite personalizar códigos de status e conteúdo de resposta. Você pode adicionar uma resposta de gateway no formato JSON na página API Groups.
Feedback
Esta página foi útil?
Deixar um comentário
Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.
O sistema está ocupado. Tente novamente mais tarde.
