API Gateway
API Gateway
Todos os resultados de "
" dentro deste produto
Todos os resultados de "
" dentro deste produto
Visão geral de serviço
Infográficos do APIG
O que é o API Gateway?
Vantagens do produto
Cenários de aplicação
Especificações
Segurança
Responsabilidades compartilhadas
Identificação e gerenciamento de ativos
Autenticação de identidade e controle de acesso
Proteção de dados
Auditoria e logs
Monitoramento de riscos de segurança
Certificados
Observações e restrições
Gerenciamento de permissões
Conceitos básicos
Cobrança
Primeiros passos
Introdução
Abertura de APIs
Fluxo do processo
Criação de um grupo de API
Vinculação de um nome de domínio
Criação de uma API
Depuração de uma API
(Opcional) Criação de um ambiente
Publicação de uma API
Chamada das APIs
Fluxo do processo
Criação de uma credencial e obtenção de autorização
Adição de um AppCode para autenticação simples
Chamada de uma API
Primeiros passos com práticas comuns
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
Criar uma credencial e vinculá-la às APIs
Redefinição de segredo
Adição de um AppCode para autenticação simples
Vinculação de uma política de cota de credenciais
Vinculação de uma política de controle de acesso
Monitoramento e análise
Monitoramento de API
Métricas de monitoramento
Criação de regras de alarme
Visualização de métricas
Monitoramento da largura de banda
Análise de logs
Gerenciamento de gateway
Compra de um gateway
Visualização ou modificação de informações do gateway
Configuração de parâmetros
Gerenciamento de tags
Gerenciamento de pontos de extremidade da VPC
Modificação de especificações
SDKs
Chamada de API publicada
Chamada das APIs
Cabeçalhos de resposta
Códigos de erro
Gerenciamento de permissões
Criação de um usuário e concessão de permissões do APIG
Políticas personalizadas do APIG
Console antigo
Visão geral
Gerenciamento de gateway
Compra de um gateway dedicado
Modificação de um gateway dedicado
Acessar o gateway compartilhado
Abertura da API
Gerenciamento do grupo de API
Criação de um grupo de API
Vinculação de um nome de domínio
Exclusão de um grupo de API
Adição de uma resposta de gateway
Gerenciamento de API
Criação de uma API
CORS
Depuração de uma API
Autorização de aplicações a chamar uma API
Publicação de uma API
Deixar uma API off-line
Exclusão de uma API
Importação de APIs
Exportação de APIs
Limitação de solicitação
Criação de uma política de limitação de solicitações
Exclusão de uma política de limitação de solicitações
Adição de uma aplicação ou locatário excluído
Remoção de uma aplicação ou locatário excluído
Controle de acesso
Criação de uma política de controle de acesso
Exclusão de uma política de controle de acesso
Gerenciamento de ambiente
Criação de um ambiente e uma variável de ambiente
Exclusão de um ambiente
Gerenciamento de chaves de assinatura
Criação e uso de uma chave de assinatura
Exclusão de uma chave de assinatura
Gerenciamento de canais da VPC
Criação de um canal da VPC
Exclusão de um canal da VPC
Edição de configurações de verificação de integridade
Edição de configurações de servidor em nuvem de um canal da VPC
Autorizadores personalizados
Criação de um autorizador personalizado
Exclusão de um autorizador personalizado
Plug-ins
Criação de um plug-in
Plug-in CORS
Plug-in de gerenciamento de cabeçalho de resposta HTTP
Plug-in de limitação de solicitação
Exclusão de um plug-in
Monitoramento
Métricas do APIG
Criação de regras de alarme
Exibição de métricas
Chamada de API
Gerenciamento de aplicações
Criação de uma aplicação e obtenção de autorização
Exclusão de uma aplicação
Redefinição do AppSecret de uma aplicação
Adição de um AppCode para autenticação simples
Visualização de detalhes da API
Análise de logs
SDKs
APIs compradas
Chamada de APIs publicadas
Chamada das APIs
Cabeçalhos de resposta
Códigos de erro
Gerenciamento de permissões
Criação de um usuário e concessão de permissões do APIG
Políticas personalizadas do APIG
Principais operações gravadas pelo CTS
Operações do APIG que podem ser gravadas pelo CTS
Consulta de logs de auditoria
Melhores práticas
Exposição seletiva de cargas de trabalho do CCE com um gateway dedicado
Introdução
Planejamento de recursos
Procedimento geral
Procedimento de implementação
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
Introdução
Planejamento de recursos
Procedimento geral
Procedimento de implementação
Interconexão de um gateway dedicado com o WAF
Limitação de solicitações 2.0 com um gateway dedicado
Introdução
Procedimento geral
Procedimento de implementação
Autenticação de dois fatores com um gateway dedicado
Introdução
Procedimento geral
Procedimento de implementação
Redirecionamento automático de HTTP para HTTPS com um gateway dedicado
Introdução
Procedimento geral
Procedimento de implementação
Roteamento de solicitações de serviço gRPC usando um gateway dedicado
Introdução
Procedimento geral
Procedimento de implementação
Autenticação de cliente com um gateway dedicado
Solução
Procedimento geral
Procedimento de implementação
Referência de API
Antes de começar
Visão geral
Chamada de API
Pontos de extremidade
Restrições
Conceitos
Visão geral de API
Gateway compartilhado
Gateway dedicado
Chamada das APIs
Criação de uma solicitação de API
Autenticação
Resposta
Primeiros passos
APIs compartilhadas de gateway (para usuários existentes)
Gerenciamento de grupos de API
Modelo de objeto
Criação de um grupo de API
Modificação de um grupo de API
Exclusão de um grupo da API
Consulta de detalhes de um grupo de APIs
Consulta da lista de grupos da 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
Modelo de objeto
Consulta da lista de APIs que não estão vinculadas a uma aplicação
Autorização de aplicações
Consulta da lista de APIs vinculadas a uma aplicação
Consulta da lista de aplicações vinculadas a uma API
Cancelamento de autorização
Gerenciamento de ambiente
Modelo de objeto
Criação de um ambiente
Modificação de um ambiente
Exclusão de um ambiente
Consulta de uma lista de ambientes
Gerenciamento de variáveis de ambiente
Modelo de objeto
Criação de uma variável de ambiente
Exclusão de uma variável de ambiente
Consulta de detalhes de variáveis de ambiente
Consulta de uma lista 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
Modelo de objeto
Criação de uma configuração de limitação de solicitação excluída
Modificação de uma configuração de limitação de solicitação excluída
Exclusão de uma configuração de limitação de solicitação excluída
Consulta da lista de configurações de limitação de solicitações excluídas
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
Consulta da lista de grupos de API comprados
Consulta de detalhes de um grupo de API comprado
Consulta da lista de APIs compradas
Gerenciamento da configuração
Modelo de objeto
Consulta de detalhes da configuração
Consulta de recursos
Consulta de quantidades de grupos de APIs
Consulta de quantidades de API
Consulta de quantidades de aplicações
Gerenciamento de chaves de assinatura
Modelo de objeto
Criação de uma chave de assinatura
Modificação de uma chave de assinatura
Exclusão de uma chave de assinatura
Consulta da lista de chaves de assinatura
Vinculação de chaves de assinatura
Modelo de objeto
Consulta da lista de APIs não vinculadas a uma chave de assinatura
Vinculação de uma chave de assinatura
Consulta da lista de APIs vinculadas a uma chave de assinatura
Consulta da lista de chaves de assinatura vinculadas a uma API
Desvinculação de uma chave de assinatura
Gerenciamento de nome de domínio
Modelo de objeto
Vinculação de um nome de domínio
Desvinculação de um nome de domínio
Adição de um certificado a um nome de domínio
Exclusão de um certificado vinculado a um nome de domínio
Consulta de detalhes de um certificado vinculado a um 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
Consulta de chamadas de API dentro de um período
Consulta de chamadas de API em um grupo de APIs na última hora
OpenAPI
Exportação de todas as APIs em um grupo de APIs
Exportação de várias APIs
Importação de APIs para um novo grupo de APIs
Importação de APIs para um grupo de APIs existente
Gerenciamento de autorizador personalizado
Criação de um autorizador personalizado
Modificação de um autorizador personalizado
Exclusão de um autorizador personalizado
Consulta de detalhes de um autorizador personalizado
Consulta de uma lista de autorizadores personalizados
APIs de gateway dedicadas (V2)
Gerenciamento de grupos de APIs
Criação de um grupo de API
Modificação de um grupo de API
Exclusão de um grupo da API
Consulta de detalhes do grupo de APIs
Consulta de grupos de API
Gerenciamento de ambiente
Criação de um ambiente
Modificação de um ambiente
Exclusão de um ambiente
Consulta de ambientes
Gerenciamento de variáveis de ambiente
Criação de uma variável
Exclusão de variável
Consulta de detalhes de variáveis
Consulta de variáveis de ambiente
Gerenciamento de política de limitação de solicitação
Criação de uma política de limitação de solicitações
Modificação de uma política de limitação de solicitações
Exclusão de uma política de limitação de solicitações
Consulta de políticas de limitação de solicitações
Consulta de detalhes de uma política de limitação de solicitações
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
Criação de uma chave de assinatura
Modificação de uma chave de assinatura
Exclusão de uma chave de assinatura
Consulta de chaves de assinatura
Vinculação/desvinculação de chaves de assinatura
Vinculação de uma chave de assinatura
Desvinculação de uma chave de assinatura
Consulta de chaves de assinatura vinculadas a uma API
Consulta de APIs não vinculadas com uma chave de assinatura
Consulta de APIs vinculadas a uma chave 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
Criação de uma configuração de limitação de solicitação excluída
Modificação de uma configuração de limitação de solicitação excluída
Exclusão de uma configuração de limitação de solicitação excluída
Consulta de configurações de limitação de solicitação excluídas
Gerenciamento de autorização de aplicações
Autorização de aplicações
Cancelamento de autorização
Consulta de APIs vinculadas a uma aplicação
Consulta de APIs não vinculadas com uma aplicação
Consulta de aplicações vinculadas a uma API
Consulta de recursos
Consulta de quantidades de API
Consulta de quantidades de grupo de APIs
Consulta de quantidades de aplicações
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
Vinculação de um nome de domínio
Adição de um certificado a um nome de domínio
Modificação de um nome de domínio
Desvinculação de um nome de domínio
Exclusão do certificado vinculado a um nome de domínio
Consulta de detalhes do certificado vinculado a um nome de domínio
Gerenciamento de política de controle de acesso
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 de políticas 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
Criação de um autorizador personalizado
Modificação de um autorizador personalizado
Exclusão de um autorizador personalizado
Consulta de detalhes do autorizador personalizado
Consulta de autorizadores personalizados
Importação e exportação de API
Exportação de APIs
Importação de APIs
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
Consulta de chamadas de API dentro de um período
Consulta de dados de monitoramento
Consulta de chamadas de API em um grupo de APIs na última hora
Gerenciamento de resposta de grupo
Criação de uma resposta de grupo
Consulta de detalhes da resposta do grupo
Modificação de uma resposta de grupo
Exclusão de uma resposta de grupo
Consulta da resposta de um tipo de erro
Modificação da resposta de um tipo de erro
Exclusão da resposta de um tipo de erro
Consulta de respostas do grupo
Gerenciamento de tags
Consulta de tags
Gerenciamento de recursos de gateway
Configuração de um recurso para um gateway
Consulta de recursos do gateway
Gerenciamento da configuração
Consulta de configurações de recursos de um gateway
Consulta de configurações de gateway
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
Consulta de paginação
Filtragem de resultados
Códigos de status HTTP
Códigos de erro
Funcionalidades suportadas
Obtenção de um ID de projeto
Obtenção de um nome de conta e um ID de conta
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
Limitação de solicitação
Posso configurar o número máximo de solicitações simultâneas?
A restrição de 1000 solicitações para um nome de subdomínio (nome de domínio de depuração) é aplicada a contas empresariais?
O APIG tem limites de largura de banda?
Por que uma política de limitação de solicitações não entra em vigor?
Controle de acesso
Como fornecer uma API aberta para usuários específicos?
Como excluir um endereço IP específico para autenticação de identidade de uma API?
Os endereços IP do cliente são verificados para controle de acesso?
Publicação de API
É necessário publicar uma API novamente após a modificação?
Por que não é possível acessar as APIs publicadas em um ambiente que não seja RELEASE?
Posso invocar diferentes serviços de back-end publicando uma API em diferentes ambientes?
Como especificar um ambiente para depuração de API?
Importação e exportação de API
Por que a importação de API falha?
O APIG fornece um modelo para importar APIs de arquivos Swagger?
Segurança da API
Como proteger minhas APIs?
Como garantir a segurança dos serviços de back-end invocados pelo APIG?
Posso controlar o acesso aos endereços IP privados dos ECSs em um canal de VPC (ou canal de balanceamento de carga)?
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?
What's New
Function Overview
Product Bulletin
Product Bulletin
Action Change Notice
Vulnerability Notices
Vulnerability Fixing Policies
Billing
Overview
Billing Modes
Introduction
Pay-per-Use
Billing Items
Bills
Arrears
Stopping Billing
Cost Management
Developer Guide
Application Scenarios
Calling APIs Through App Authentication
Preparation
App Authentication
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
Calling APIs Through IAM Authentication
Token Authentication
AK/SK Authentication
Creating Signatures for Backend Requests
Pre-signature Preparations
Java
Python
C#
SDK Reference
SDK Overview
Videos
More Documents
User Guide (Kuala Lumpur Region)
Service Overview
What Is APIG?
Product Advantages
Application Scenarios
Specifications
Notes and Constraints
Permissions Management
Basic Concepts
Getting Started
Introduction
Opening APIs
Process Flow
Creating an API Group
Binding a Domain Name
Creating an API
Debugging an API
(Optional) Creating an Environment
Publishing an API
Calling APIs
Process Flow
Creating a Credential and Getting Authorized
Adding an AppCode for Simple Authentication
Calling an API
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
Creating a Policy and Binding It to APIs
CORS
HTTP Response Header Management
Request Throttling 2.0
Kafka Log Push
Circuit Breaker
Third-Party Authorizer
Request Throttling
Access Control
Signature Keys
Custom Authorizers
SSL Certificates
Load Balance Channels
Managing Environments
Credentials
Creating a Credential and Binding It to APIs
Resetting Secret
Adding an AppCode for Simple Authentication
Binding a Credential Quota Policy
Binding an Access Control Policy
Monitoring & Analysis
API Monitoring
Monitoring Metrics
Creating Alarm Rules
Viewing Metrics
Bandwidth Monitoring
Log Analysis
Gateway Management
Buying a Gateway
Viewing or Modifying Gateway Information
Configuring Parameters
Managing Tags
Managing VPC Endpoints
Modifying Specifications
SDKs
Published API Calling
Calling APIs
Response Headers
Error Codes
Permissions Management
Creating a User and Granting APIG Permissions
APIG Custom Policies
Auditing
APIG Operations Recorded by CTS
Querying Real-Time Traces
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
Request Throttling
Can I Configure the Maximum Number of Concurrent Requests?
Is the Restriction of 1000 Requests per Day to a Subdomain Name (Debugging Domain Name) Applied to Enterprise Accounts?
Does APIG Have Bandwidth Limits?
Why Doesn't a Request Throttling Policy Take Effect?
Access Control
How Do I Provide an Open API to Specific Users?
How Do I Exclude a Specific IP Address for Identity Authentication of an API?
Are Client IP Addresses Verified for Access Control?
API Publishing
Do I Need to Publish an API Again After Modification?
Can I Access an API Published in a Non-RELEASE Environment?
Can I Invoke Different Backend Services by Publishing an API in Different Environments?
Can I Specify an Environment for API Debugging?
API Import and Export
Why Does API Import Fail?
Does APIG Provide a Template for Importing APIs from Swagger Files?
API Security
How Can I Protect My APIs?
How Do I Ensure the Security of Backend Services Invoked by APIG?
Can I Control Access to the Private IP Addresses of the ECSs in a VPC Channel (or Load Balance Channel)?
Other FAQs
What Are the Relationships Between an API, Environment, and App (Credential)?
How Can I Use APIG?
What SDK Languages Does APIG Support?
Can I Upload Files Using the POST Method?
What Are the Error Messages Returned by APIG Like?
Change History
Developer Guide (Kuala Lumpur Region)
Application Scenarios
Calling APIs Through App Authentication
Preparation
App Authentication
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
Calling APIs Through IAM Authentication
Token Authentication
AK/SK Authentication
Creating Signatures for Backend Requests
Pre-signature Preparations
Java
Python
C#
Change History
API Reference (Kuala Lumpur Region)
Before You Start
Calling APIs
Making an API Request
Authentication
Response
Dedicated Gateway APIs (V2)
API Group Management
Creating an API Group
Modifying an API Group
Deleting an API Group
Querying API Group Details
Querying API Groups
Verifying an API Group Name
Environment Management
Creating an Environment
Modifying an Environment
Deleting an Environment
Querying Environments
Environment Variable Management
Creating a Variable
Deleting a Variable
Querying Variable Details
Querying Environment Variables
Modifying a Variable
Request Throttling Policy Management
Creating a Request Throttling Policy
Modifying a Request Throttling Policy
Deleting a Request Throttling Policy
Querying Request Throttling Policies
Querying Details of a Request Throttling Policy
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
Creating a Signature Key
Modifying a Signature Key
Deleting a Signature Key
Querying Signature Keys
Binding/Unbinding Signature Keys
Binding a Signature Key
Unbinding a Signature Key
Querying Signature Keys Bound to an API
Querying APIs Not Bound with a Signature Key
Querying APIs Bound with a Signature Key
Binding/Unbinding Request Throttling Policies
Binding a Request Throttling Policy
Unbinding a Request Throttling Policy
Querying APIs Bound with a Request Throttling Policy
Querying APIs Not Bound with a Request Throttling Policy
Querying Request Throttling Policies Bound to an API
Unbinding Request Throttling Policies
Excluded Request Throttling Configuration
Creating an Excluded Request Throttling Configuration
Modifying an Excluded Request Throttling Configuration
Deleting an Excluded Request Throttling Configuration
Querying Excluded Request Throttling Configurations
App Authorization Management
Authorizing Apps
Canceling Authorization
Querying APIs Bound with an App
Querying APIs Not Bound with an App
Querying Apps Bound to an API
Resource Query
Querying API Quantities
Querying API Group Quantities
Querying App Quantities
Domain Name Management
Binding a Domain Name
Adding a Certificate to a Domain Name
Modifying a Domain Name
Unbinding a Domain Name
Setting Accessibility of a Debugging Domain Name
Deleting the Certificate Bound to a Domain Name
Querying Details of the Certificate Bound to a Domain Name
Access Control Policy Management
Creating an Access Control Policy
Modifying an Access Control Policy
Deleting an Access Control Policy
Deleting Multiple Access Control Policies
Querying Details of an Access Control Policy
Querying Access Control Policies
Binding/Unbinding Access Control Policies
Binding an Access Control Policy to an API
Unbinding an Access Control Policy
Unbinding Access Control Policies
Querying APIs Bound with an Access Control Policy
Querying APIs Not Bound with an Access Control Policy
Querying Access Control Policies Bound to an API
Custom Authorizer Management
Creating a Custom Authorizer
Modifying a Custom Authorizer
Deleting a Custom Authorizer
Querying Custom Authorizer Details
Querying Custom Authorizers
API Import and Export
Exporting APIs
Importing APIs
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
Querying API Calls Within a Period
Querying Monitoring Data
Querying API Calls Under an API Group in the Last One Hour
Group Response Management
Creating a Group Response
Querying Group Response Details
Modifying a Group Response
Deleting a Group Response
Querying the Response of an Error Type
Modifying the Response of an Error Type
Deleting the Response of an Error Type
Querying Group Responses
Tag Management
Querying Tags
Gateway Feature Management
Configuring a Feature for a Gateway
Querying Gateway Features
Querying the Supported Features of a Gateway
Configuration Management
Querying Resource Configurations of a Gateway
Querying Gateway Configurations
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
Querying VPC Endpoint Connections
Accepting or Rejecting a VPC Endpoint Connection
Querying Whitelist Records of a VPC Endpoint Service
Adding Whitelist Records for a VPC Endpoint Service
Deleting Whitelist Records of a VPC Endpoint Service
Gateway Tag Management
Querying All Gateway Tags of a Project
Querying Tags of a Gateway
Adding or Deleting Tags of a Gateway
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
Exporting APIs Asynchronously
Importing APIs Asynchronously
Querying the Result of an Asynchronous Task
Permissions Policies and Supported Actions
Appendix
Pagination Query
Result Filtering
HTTP Status Codes
Error Codes
Supported Features
Obtaining a Project ID
Obtaining an Account Name and Account ID
Change History
User Guide (ME-Abu Dhabi Region)
Service Overview
What Is APIG?
Product Advantages
Application Scenarios
Specifications
Notes and Constraints
Permissions Management
Basic Concepts
Billing
Getting Started
Introduction
Opening APIs
Process Flow
Creating an API Group
Binding a Domain Name
Creating an API
Debugging an API
(Optional) Creating an Environment
Publishing an API
Calling APIs
Process Flow
Creating a Credential and Getting Authorized
Adding an AppCode for Simple Authentication
Calling an API
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
Creating a Policy and Binding It to APIs
CORS
HTTP Response Header Management
Request Throttling 2.0
Kafka Log Push
Circuit Breaker
Third-Party Authorizer
Request Throttling
Access Control
Signature Keys
Custom Authorizers
SSL Certificates
Load Balance Channels
Managing Environments
Credentials
Creating a Credential and Binding It to APIs
Resetting Secret
Adding an AppCode for Simple Authentication
Binding a Credential Quota Policy
Binding an Access Control Policy
Monitoring & Analysis
API Monitoring
Monitoring Metrics
Creating Alarm Rules
Viewing Metrics
Bandwidth Monitoring
Log Analysis
Gateway Management
Buying a Gateway
Viewing or Modifying Gateway Information
Configuring Parameters
Managing Tags
Managing VPC Endpoints
Modifying Specifications
SDKs
Published API Calling
Calling APIs
Response Headers
Error Codes
Permissions Management
Creating a User and Granting APIG Permissions
APIG Custom Policies
Auditing
APIG Operations Recorded by CTS
Querying Real-Time Traces
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
Request Throttling
Can I Configure the Maximum Number of Concurrent Requests?
Is the Restriction of 1000 Requests per Day to a Subdomain Name (Debugging Domain Name) Applied to Enterprise Accounts?
Does APIG Have Bandwidth Limits?
Why Doesn't a Request Throttling Policy Take Effect?
Access Control
How Do I Provide an Open API to Specific Users?
How Do I Exclude a Specific IP Address for Identity Authentication of an API?
Are Client IP Addresses Verified for Access Control?
API Publishing
Do I Need to Publish an API Again After Modification?
Can I Access an API Published in a Non-RELEASE Environment?
Can I Invoke Different Backend Services by Publishing an API in Different Environments?
Can I Specify an Environment for API Debugging?
API Import and Export
Why Does API Import Fail?
Does APIG Provide a Template for Importing APIs from Swagger Files?
API Security
How Can I Protect My APIs?
How Do I Ensure the Security of Backend Services Invoked by APIG?
Can I Control Access to the Private IP Addresses of the ECSs in a VPC Channel (or Load Balance Channel)?
Other FAQs
What Are the Relationships Between an API, Environment, and App (Credential)?
How Can I Use APIG?
What SDK Languages Does APIG Support?
Can I Upload Files Using the POST Method?
What Are the Error Messages Returned by APIG Like?
Change History
Developer Guide (ME-Abu Dhabi Region)
Application Scenarios
Calling APIs Through App Authentication
Preparation
App Authentication
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
Calling APIs Through IAM Authentication
Token Authentication
AK/SK Authentication
Creating a Function for Frontend Custom Authentication
Creating a Function for Backend Custom Authentication
Creating Signatures for Backend Requests
Pre-signature Preparations
Java
Python
C#
Change History
API Reference (ME-Abu Dhabi Region)
Before You Start
Calling APIs
Making an API Request
Authentication
Response
Dedicated Gateway APIs (V2)
API Group Management
Creating an API Group
Modifying an API Group
Deleting an API Group
Querying API Group Details
Querying API Groups
Verifying an API Group Name
Environment Management
Creating an Environment
Modifying an Environment
Deleting an Environment
Querying Environments
Environment Variable Management
Creating a Variable
Deleting a Variable
Querying Variable Details
Querying Environment Variables
Modifying a Variable
Request Throttling Policy Management
Creating a Request Throttling Policy
Modifying a Request Throttling Policy
Deleting a Request Throttling Policy
Querying Request Throttling Policies
Querying Details of a Request Throttling Policy
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
Creating a Signature Key
Modifying a Signature Key
Deleting a Signature Key
Querying Signature Keys
Binding/Unbinding Signature Keys
Binding a Signature Key
Unbinding a Signature Key
Querying Signature Keys Bound to an API
Querying APIs Not Bound with a Signature Key
Querying APIs Bound with a Signature Key
Binding/Unbinding Request Throttling Policies
Binding a Request Throttling Policy
Unbinding a Request Throttling Policy
Querying APIs Bound with a Request Throttling Policy
Querying APIs Not Bound with a Request Throttling Policy
Querying Request Throttling Policies Bound to an API
Unbinding Request Throttling Policies
Excluded Request Throttling Configuration
Creating an Excluded Request Throttling Configuration
Modifying an Excluded Request Throttling Configuration
Deleting an Excluded Request Throttling Configuration
Querying Excluded Request Throttling Configurations
App Authorization Management
Authorizing Apps
Canceling Authorization
Querying APIs Bound with an App
Querying APIs Not Bound with an App
Querying Apps Bound to an API
Resource Query
Querying API Quantities
Querying API Group Quantities
Querying App Quantities
Domain Name Management
Binding a Domain Name
Adding a Certificate to a Domain Name
Modifying a Domain Name
Unbinding a Domain Name
Setting Accessibility of a Debugging Domain Name
Deleting the Certificate Bound to a Domain Name
Querying Details of the Certificate Bound to a Domain Name
Access Control Policy Management
Creating an Access Control Policy
Modifying an Access Control Policy
Deleting an Access Control Policy
Deleting Multiple Access Control Policies
Querying Details of an Access Control Policy
Querying Access Control Policies
Binding/Unbinding Access Control Policies
Binding an Access Control Policy to an API
Unbinding an Access Control Policy
Unbinding Access Control Policies
Querying APIs Bound with an Access Control Policy
Querying APIs Not Bound with an Access Control Policy
Querying Access Control Policies Bound to an API
Custom Authorizer Management
Creating a Custom Authorizer
Modifying a Custom Authorizer
Deleting a Custom Authorizer
Querying Custom Authorizer Details
Querying Custom Authorizers
API Import and Export
Exporting APIs
Importing APIs
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
Querying API Calls Within a Period
Querying Monitoring Data
Querying API Calls Under an API Group in the Last One Hour
Group Response Management
Creating a Group Response
Querying Group Response Details
Modifying a Group Response
Deleting a Group Response
Querying the Response of an Error Type
Modifying the Response of an Error Type
Deleting the Response of an Error Type
Querying Group Responses
Tag Management
Querying Tags
Gateway Feature Management
Configuring a Feature for a Gateway
Querying Gateway Features
Querying the Supported Features of a Gateway
Configuration Management
Querying Resource Configurations of a Gateway
Querying Gateway Configurations
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
Querying VPC Endpoint Connections
Accepting or Rejecting a VPC Endpoint Connection
Querying Whitelist Records of a VPC Endpoint Service
Adding Whitelist Records for a VPC Endpoint Service
Deleting Whitelist Records of a VPC Endpoint Service
Gateway Tag Management
Querying All Gateway Tags of a Project
Querying Tags of a Gateway
Adding or Deleting Tags of a Gateway
Microservice Center Management
Importing a Microservice
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
Exporting APIs Asynchronously
Importing APIs Asynchronously
Querying the Result of an Asynchronous Task
Permissions Policies and Supported Actions
Appendix
Pagination Query
Result Filtering
HTTP Status Codes
Error Codes
Supported Features
Obtaining a Project ID
Obtaining an Account Name and Account ID
Change History
Best Practices (ME-Abu Dhabi Region)
Selectively Exposing CCE Workloads with a Dedicated Gateway
Introduction
Resource Planning
General Procedure
Implementation Procedure
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
Introduction
Resource Planning
General Procedure
Implementation Procedure
Interconnecting a Dedicated Gateway with WAF
Request Throttling 2.0 with a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
Two-Factor Authentication with a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
HTTP-to-HTTPS Auto Redirection with a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
Client Authentication with a Dedicated Gateway
Solution
General Procedure
Implementation Procedure
Invoking an API Policy Backend via Frontend Authentication Parameters (System Parameter)
Introduction
General Procedure
Implementation Procedure
Forwarding WebSocket Services Using Dedicated Gateway
Change History
User Guide (Paris Region)
Overview
Getting Started
Introduction
Opening APIs
Process Flow
Creating an API Group
Binding a Domain Name
Creating an API
Debugging an API
(Optional) Creating an Environment
Publishing an API
Calling APIs
Process Flow
Creating an App and Getting Authorized
Adding an AppCode for Simple Authentication
Calling an API
API Opening
API Group Management
Creating an API Group
Binding a Domain Name
Deleting an API Group
Adding a Gateway Response
API Management
Creating an API
CORS
Debugging an API
Authorizing Apps to Call an API
Publishing an API
Taking an API Offline
Deleting an API
Importing APIs
Exporting APIs
Request Throttling
Creating a Request Throttling Policy
Deleting a Request Throttling Policy
Adding an Excluded App or Tenant
Removing an Excluded App or Tenant
Access Control
Creating an Access Control Policy
Deleting an Access Control Policy
Environment Management
Creating an Environment and Environment Variable
Deleting an Environment
Signature Key Management
Creating and Using a Signature Key
Deleting a Signature Key
VPC Channel Management
Creating a VPC Channel
Deleting a VPC Channel
Editing Health Check Configurations
Editing Cloud Server Configurations of a VPC Channel
Custom Authorizers
Creating a Custom Authorizer
Deleting a Custom Authorizer
Monitoring
API Gateway Metrics
Creating Alarm Rules
Viewing Metrics
API Calling
App Management
Creating an App and Obtaining Authorization
Deleting an App
Resetting the AppSecret of an App
Adding an AppCode for Simple Authentication
Viewing API Details
SDKs
Calling Published APIs
Calling APIs
Response Headers
Error Codes
Auditing
Quota Management
Developer Guide (Paris Region)
Application Scenarios
Calling APIs Through App Authentication
Preparation
App Authentication
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
Calling APIs Through IAM Authentication
Token Authentication
AK/SK Authentication
Creating Signatures for Backend Requests
Pre-signature Preparations
Java
Python
C#
Importing and Exporting APIs
Restrictions and Compatibility
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
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
x-apigateway-backend-policies.conditions
x-apigateway-ratelimit
x-apigateway-ratelimits
x-apigateway-ratelimits
x-apigateway-ratelimits.policy
x-apigateway-ratelimits.policy.special
x-apigateway-access-control
x-apigateway-access-controls
x-apigateway-access-controls
x-apigateway-access-controls.policy
x-apigateway-plugins
API Import Precautions
Examples of Importing APIs
Importing an HTTP Backend Service API
Importing an HTTP VPC Backend Service API
Importing a Function Backend Service API
Importing a Mock Backend Service API
API Export Precautions
Change History
API Reference (Paris Region)
Before You Start
Overview
API Calling
Endpoints
Constraints
Concepts
Calling APIs
Making an API Request
Authentication
Response
Getting Started
Shared Gateway APIs
API Group Management
Object Model
Creating an API Group
Modifying an API Group
Deleting an API Group
Querying Details of an API Group
Querying the API Group List
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
Object Model
Creating an App
Modifying an App
Resetting an AppSecret
Deleting an App
Verifying an App
Querying App Details
Querying an App List
App Authorization Management
Object Model
Querying the List of APIs Not Bound to an App
Authorizing Apps
Querying the List of APIs Bound to an App
Querying the List of Apps Bound to an API
Canceling Authorization
Environment Management
Object Model
Creating an Environment
Modifying an Environment
Deleting an Environment
Querying an Environment List
Environment Variable Management
Object Model
Creating an Environment Variable
Deleting an Environment Variable
Querying Environment Variable Details
Querying an Environment Variable List
Request Throttling Policy Management
Object Model
Creating a Request Throttling Policy
Modifying a Request Throttling Policy
Deleting a Request Throttling Policy
Querying Details of a Request Throttling Policy
Querying the Request Throttling Policy List
Binding Request Throttling Policies
Object Model
Querying the List of APIs Not Bound to a Request Throttling Policy
Binding a Request Throttling Policy
Querying the List of APIs Bound to a Request Throttling Policy
Querying the List of Request Throttling Policies Bound to an API
Unbinding a Request Throttling Policy
Excluded Request Throttling Configuration
Object Model
Creating an Excluded Request Throttling Configuration
Modifying an Excluded Request Throttling Configuration
Deleting an Excluded Request Throttling Configuration
Querying the List of Excluded Request Throttling Configurations
Access Control Policy Management
Object Model
Creating an Access Control Policy
Modifying an Access Control Policy
Deleting an Access Control Policy
Deleting Multiple Access Control Policies
Querying Details of an Access Control Policy
Querying the Access Control Policy List
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
Querying the List of Purchased API Groups
Querying Details of a Purchased API Group
Querying the List of Purchased APIs
Resource Query
Querying API Group Quantities
Querying API Quantities
Querying App Quantities
Signature Key Management
Object Model
Creating a Signature Key
Modifying a Signature Key
Deleting a Signature Key
Querying the Signature Key List
Binding Signature Keys
Object Model
Querying the List of APIs Not Bound to a Signature Key
Binding a Signature Key
Querying the List of APIs Bound to a Signature Key
Querying the List of Signature Keys Bound to an API
Unbinding a Signature Key
Domain Name Management
Object Model
Binding a Domain Name
Unbinding a Domain Name
Adding a Certificate to a Domain Name
Deleting a Certificate Bound to a Domain Name
Querying Details of a Certificate Bound to a Domain Name
VPC Channel Management
Object Model
Creating a VPC Channel
Updating a VPC Channel
Deleting a VPC Channel
Querying VPC Channel Details
Querying the VPC channel List
Adding Backend Instances (Cloud Servers)
Deleting a Backend Instance (Cloud Server)
Querying the Backend Instance List (Cloud Server List)
OpenAPI
Exporting All APIs in an API Group
Exporting Multiple APIs
Importing APIs to a New API Group
Importing APIs to an Existing API Group
Custom Authorizer Management
Creating a Custom Authorizer
Modifying a Custom Authorizer
Deleting a Custom Authorizer
Querying Details of a Custom Authorizer
Querying a Custom Authorizer List
Appendix
Pagination Query
Result Filtering
HTTP Status Codes
Error Codes
Obtaining a Project ID
Obtaining an Account Name and Account ID
Change History
Dedicated API Gateway User Guide (Paris Region)
Service Overview
What Is APIG?
Product Advantages
Application Scenarios
Specifications
Notes and Constraints
Permissions Management
Basic Concepts
Billing
Getting Started
Introduction
Opening APIs
Process Flow
Creating an API Group
Binding a Domain Name
Creating an API
Debugging an API
(Optional) Creating an Environment
Publishing an API
Calling APIs
Process Flow
Creating a Credential and Getting Authorized
Adding an AppCode for Simple Authentication
Calling an API
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
Creating a Policy and Binding It to APIs
CORS
HTTP Response Header Management
Request Throttling 2.0
Kafka Log Push
Circuit Breaker
Request Throttling
Access Control
Signature Keys
Custom Authorizers
SSL Certificates
Load Balance Channels
Managing Environments
Credentials
Creating a Credential and Binding It to APIs
Resetting Secret
Adding an AppCode for Simple Authentication
Binding a Credential Quota Policy
Binding an Access Control Policy
Monitoring & Analysis
API Monitoring
Monitoring Metrics
Creating Alarm Rules
Viewing Metrics
Log Analysis
Gateway Management
Creating a Gateway
Viewing or Modifying Gateway Information
Configuring Parameters
Managing VPC Endpoints
Published API Calling
Calling APIs
Response Headers
Error Codes
Permissions Management
Creating a User and Granting APIG Permissions
APIG Custom Policies
Auditing
APIG Operations Recorded by CTS
Querying Real-Time Traces
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
Request Throttling
Can I Configure the Maximum Number of Concurrent Requests?
Is the Restriction of 1000 Requests per Day to a Subdomain Name (Debugging Domain Name) Applied to Enterprise Accounts?
Does APIG Have Bandwidth Limits?
Why Doesn't a Request Throttling Policy Take Effect?
Access Control
How Do I Provide an Open API to Specific Users?
How Do I Exclude a Specific IP Address for Identity Authentication of an API?
Are Client IP Addresses Verified for Access Control?
API Publishing
Do I Need to Publish an API Again After Modification?
Can I Access an API Published in a Non-RELEASE Environment?
Can I Invoke Different Backend Services by Publishing an API in Different Environments?
Can I Specify an Environment for API Debugging?
API Import and Export
Why Does API Import Fail?
Does APIG Provide a Template for Importing APIs from Swagger Files?
API Security
How Can I Protect My APIs?
How Do I Ensure the Security of Backend Services Invoked by APIG?
Can I Control Access to the Private IP Addresses of the ECSs in a VPC Channel (or Load Balance Channel)?
Other FAQs
What Are the Relationships Between an API, Environment, and App (Credential)?
How Can I Use APIG?
What SDK Languages Does APIG Support?
Can I Upload Files Using the POST Method?
What Are the Error Messages Returned by APIG Like?
Change History
Dedicated API Gateway Developer Guide (Paris Region)
Application Scenarios
Calling APIs Through App Authentication
Preparation
App Authentication
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
Calling APIs Through IAM Authentication
Token Authentication
AK/SK Authentication
Creating Signatures for Backend Requests
Pre-signature Preparations
Java
Python
C#
Change History
Dedicated API Gateway API Reference (Paris Region)
Before You Start
Calling APIs
Making an API Request
Authentication
Response
Dedicated Gateway APIs (V2)
API Group Management
Creating an API Group
Modifying an API Group
Deleting an API Group
Querying API Group Details
Querying API Groups
Environment Management
Creating an Environment
Modifying an Environment
Deleting an Environment
Querying Environments
Environment Variable Management
Creating a Variable
Deleting a Variable
Querying Variable Details
Querying Environment Variables
Request Throttling Policy Management
Creating a Request Throttling Policy
Modifying a Request Throttling Policy
Deleting a Request Throttling Policy
Querying Request Throttling Policies
Querying Details of a Request Throttling Policy
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
Creating a Signature Key
Modifying a Signature Key
Deleting a Signature Key
Querying Signature Keys
Binding/Unbinding Signature Keys
Binding a Signature Key
Unbinding a Signature Key
Querying Signature Keys Bound to an API
Querying APIs Not Bound with a Signature Key
Querying APIs Bound with a Signature Key
Binding/Unbinding Request Throttling Policies
Binding a Request Throttling Policy
Unbinding a Request Throttling Policy
Querying APIs Bound with a Request Throttling Policy
Querying APIs Not Bound with a Request Throttling Policy
Querying Request Throttling Policies Bound to an API
Unbinding Request Throttling Policies
Excluded Request Throttling Configuration
Creating an Excluded Request Throttling Configuration
Modifying an Excluded Request Throttling Configuration
Deleting an Excluded Request Throttling Configuration
Querying Excluded Request Throttling Configurations
App Authorization Management
Authorizing Apps
Canceling Authorization
Querying APIs Bound with an App
Querying APIs Not Bound with an App
Querying Apps Bound to an API
Resource Query
Querying API Quantities
Querying API Group Quantities
Querying App Quantities
App 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
Domain Name Management
Binding a Domain Name
Adding a Certificate to a Domain Name
Modifying a Domain Name
Unbinding a Domain Name
Deleting the Certificate Bound to a Domain Name
Querying Details of the Certificate Bound to a Domain Name
Access Control Policy Management
Creating an Access Control Policy
Modifying an Access Control Policy
Deleting an Access Control Policy
Deleting Multiple Access Control Policies
Querying Details of an Access Control Policy
Querying Access Control Policies
Binding/Unbinding Access Control Policies
Binding an Access Control Policy to an API
Unbinding an Access Control Policy
Unbinding Access Control Policies
Querying APIs Bound with an Access Control Policy
Querying APIs Not Bound with an Access Control Policy
Querying Access Control Policies Bound to an API
Custom Authorizer Management
Creating a Custom Authorizer
Modifying a Custom Authorizer
Deleting a Custom Authorizer
Querying Custom Authorizer Details
Querying Custom Authorizers
API Import and Export
Exporting APIs
Importing APIs
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
Monitoring Information Query
Querying API Calls Within a Period
Querying Monitoring Data
Querying API Calls Under an API Group in the Last One Hour
Group Response Management
Creating a Group Response
Querying Group Response Details
Modifying a Group Response
Deleting a Group Response
Querying the Response of an Error Type
Modifying the Response of an Error Type
Deleting the Response of an Error Type
Querying Group Responses
Tag Management
Querying Tags
Gateway Feature Management
Configuring a Feature for a Gateway
Querying Gateway Features
Configuration Management
Querying Resource Configurations of a Gateway
Querying Gateway Configurations
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
Pagination Query
Result Filtering
HTTP Status Codes
Error Codes
Supported Features
Obtaining a Project ID
Obtaining an Account Name and Account ID
Change History