- Descripción general del servicio
- Pasos iniciales
-
Guía del usuario
- Descripción general
- Gestión de Gateway
- API Opening
- Llamadas a API
- Gestión de permisos
- Operaciones clave registradas por CTS
-
Referencia de la API
- Antes de comenzar
- Descripción de la API
- Invocaciones a APIs
- Pasos iniciales
-
Las API de gateway compartido (para usuarios existentes)
- Gestión de grupo de API
-
Gestión de API
- Modelo de objetos
- Creación de una API
- Modificación de una API
- Eliminación de una API
- Publicación de una API
- Desconexión de una API
- Publicar varias APIs o quitar varias APIs desconectadas
- Consulta de detalles de la API
- Consulta de una lista de API
- Consulta de versiones históricas de API
- Poner una versión efectiva de una API fuera de línea
- Consulta de detalles de una versión de API
- Consulta de la definición de tiempo de ejecución de una API
- Depuración de una API
-
Gestión de aplicaciones
- Modelo de objetos
- Creación de una aplicación
- Modificación de una aplicación
- Restablecimiento de un AppSecret
- Eliminación de una App
- Verificación de una aplicación
- Consulta de los detalles de la aplicación
- Consulta de una lista de aplicaciones
- Creación de un AppCode
- Generación de un AppCode
- Consulta de detalles de AppCode
- Consulta de una lista de AppCode
- Eliminación de un AppCode
- Gestión de autorización de aplicaciones
- Gestión de entorno
- Gestión de variables de entorno
-
Solicitud de gestión de políticas de limitación
- Modelo de objetos
- Creación de una política de limitación de solicitudes
- Modificación de una política de limitación de solicitudes
- Eliminación de una política de limitación de solicitudes
- Consulta de detalles de una política de limitación de solicitudes
- Consulta de la lista de políticas de limitación de solicitudes
-
Políticas de limitación de solicitud de enlace
- Modelo de objetos
- Consulta de la lista de APIs no vinculadas a una política de limitación de solicitudes
- Vinculación de una política de limitación de solicitudes
- Consulta de la lista de API vinculadas a una política de limitación de solicitudes
- Consulta de la lista de políticas de limitación de solicitudes vinculadas a una API
- Desvinculación de una política de limitación de solicitudes
-
Configuración de limitación de solicitud excluida
- Modelo de objetos
- Creación de una configuración de limitación de solicitudes excluidas
- Modificación de una configuración de limitación de solicitudes excluidas
- Eliminación de una configuración de limitación de solicitudes excluidas
- Consulta de la lista de configuraciones de limitación de solicitudes excluidas
-
Gestión de políticas de control de acceso
- Modelo de objetos
- Creación de una política de control de acceso
- Modificación de una política de control de acceso
- Eliminación de una política de control de acceso
- Eliminación de varias políticas de control de acceso
- Consulta de detalles de una política de control de acceso
- Consulta de la lista de políticas de control de acceso
-
Vinculación de políticas de control de acceso
- Modelo de objetos
- Vinculación de una política de control de acceso a una API
- Consulta de la lista de políticas de control de acceso vinculadas a una API
- Consulta de la lista de API vinculadas a una política de control de acceso
- Consulta de la lista de APIs no vinculadas a una política de control de acceso
- Desvinculación de una política de control de acceso de una API
- Desvinculación de varias políticas de control de acceso de las API
- Consulta de información de suscripción en KooGallery
- Gestión de configuración
- Consulta de recursos
- Gestión de clave de firma
- Vinculación de claves de firma
- Gestión de nombres de dominio
-
Gestión de canales de VPC
- Modelo de objetos
- Creación de un canal de VPC
- Actualización de un canal de VPC
- Eliminación de un canal de VPC
- Consulta de detalles del canal de VPC
- Consulta de la lista de canales de VPC
- Adición de instancias de backend (servidores en la nube)
- Eliminación de una instancia de backend (servidor en la nube)
- Consulta de la lista de instancias de backend (lista de servidores en la nube)
- Consulta de métricas
- OpenAPI
- Gestión de autorizador personalizado
-
Las API de gateway dedicado (V2)
- Gestión de grupo API
- Gestión de entorno
- Gestión de variables de entorno
- Solicitud de gestión de políticas de limitación
-
Gestión de API
- Registrar una API
- Modificación de una API
- Eliminación de una API
- Publicar una API o poner una API fuera de línea
- Consulta de detalles de la API
- Consulta de APIs
- Depuración de una API
- Publicar APIs o tomar APIs fuera de línea
- Consulta de versiones históricas de una API
- Cambiar la versión de una API
- Consulta de la definición de tiempo de ejecución de una API
- Consulta de detalles de la versión de la API
- Desconexión de una versión de API
- Gestión de clave de firma
- Vinculación/desvinculación de claves de firma
-
Políticas de limitación de solicitudes de vincualción/desvinculación
- Vinculación de una política de limitación de solicitudes
- Desvinculación de una política de limitación de solicitudes
- Consulta de APIs vinculadas con una política de limitación de solicitudes
- Consulta de APIs no vinculadas con una política de limitación de solicitudes
- Consulta de políticas de limitación de solicitudes vinculadas a una API
- Desvinculación de políticas de limitación de solicitudes
- Configuración de limitación de solicitud excluida
- Gestión de Autorización de Aplicaciones
- Consulta de recursos
-
Gestión de aplicaciones
- Creación de una aplicación
- Modificación de una aplicación
- Eliminación de una App
- Restablecimiento del AppSecret de una aplicación
- Verificación de una aplicación
- Consulta de los detalles de la aplicación
- Consulta de aplicaciones
- Creación de un AppCode
- Generación de un AppCode
- Eliminación de un AppCode
- Consulta de detalles de AppCode
- Consulta del AppCodes de una aplicación
- Gestión de nombres de dominio
- Gestión de políticas de control de acceso
-
Políticas de control de acceso de vinculación/desvinculación
- Vinculación de una política de control de acceso a una API
- Desvinculación de una política de control de acceso
- Desvinculación de políticas de control de acceso
- Consulta de API vinculadas con una política de control de acceso
- Consulta de APIs no vinculadas con una política de control de acceso
- Consulta de políticas de control de acceso vinculadas a una API
- Gestión de Autorizador Personalizado
- Importación y exportación de API
-
Gestión de canales de VPC
- Creación de un canal de VPC
- Actualización de un canal de VPC
- Eliminación de un canal de VPC
- Consulta de detalles del canal de VPC
- Consulta de canales de VPC
- Adición o actualización de instancias de backend
- Consulta de servidores de backend de un canal de VPC
- Actualización de instancias de backend
- Eliminación de un servidor backend
- Habilitación de servidores de backend
- Deshabilitación de servidores de backend
- Modificación de la comprobación del estado del canal de VPC
- Adición o actualización de un grupo de servidores backend de un canal de VPC
- Consulta de grupos de servidores backend de un canal de VPC
- Consulta de un grupo de servidores backend de un canal de VPC
- Eliminación de un grupo de servidores de backend de un canal de VPC
- Actualización de un grupo de servidores backend de un canal de VPC
- Consulta de información de monitoreo
-
Gestión de Respuestas de Grupo
- Creación de una respuesta de grupo
- Consulta de detalles de respuesta de grupo
- Modificación de una respuesta de grupo
- Eliminación de una respuesta de grupo
- Consulta de la respuesta de un tipo de error
- Modificación de la respuesta de un tipo de error
- Eliminación de la respuesta de un tipo de error
- Consulta de respuestas de grupo
- Gestión de etiquetas
- Gestión de características de gateway
- Gestión de configuraciones
-
Gestión de Gateway
- Creación de un Gateway dedicado
- Consulta de detalles de gateway dedicado
- Actualización de un gateway dedicado
- Consulta del progreso de creación de un gateway dedicado
- Actualización o vinculación de un EIP a un gateway dedicado
- Desvinculación del EIP de un gateway dedicado
- Habilitación del acceso público para un gateway dedicado
- Actualización del ancho de banda de acceso saliente de un gateway dedicado
- Deshabilitación del acceso público para un gateway dedicado
- Consulta de AZs
- Consulta de gateway dedicados
- Eliminación de un gateway dedicado
- Políticas de permisos y acciones admitidas
- Apéndice
- Historial de cambios
-
Preguntas frecuentes
- Preguntas frecuentes comunes
-
Creación de API
- ¿Por qué no puedo crear API?
- ¿Cómo defino los códigos de respuesta para una API?
- ¿Cómo especifico el puerto de host para un canal de VPC (o canal de equilibrio de carga)?
- ¿Cómo configuro la dirección de backend si no usaré un canal de VPC (o un canal de balanceo de carga)?
- ¿Cómo puedo configurar la dirección del servicio backend?
- ¿Puedo especificar una dirección de balanceador de carga de red privada para el servicio backend?
- ¿Puedo especificar la dirección de backend como una dirección IP de subred?
- ¿APIG admite varios puntos de conexión backend?
- ¿Qué debo hacer después de solicitar un nombre de dominio independiente?
- ¿Puedo vincular nombres de dominio privados para el acceso a la API?
- ¿Por qué no se puede invocar a una API entre los dominios?
-
Invocación a API
- ¿Cuáles son las posibles causas de un error de invocación a la API?
- ¿Qué debo hacer si se devuelve un código de error durante las invocaciones a la API?
- ¿Por qué veo el mensaje de error "414 Request-URI Too Large" cuando invoco a una API?
- ¿Qué debo hacer si se muestra "The API does not exist or has not been published in the environment."?
- ¿Por qué veo el mensaje "No backend available"?
- ¿Cuáles son las posibles causas si se muestra el mensaje "Backend unavailable" o "Backend timeout"?
- ¿Por qué veo el mensaje "Backend domain name resolution failed" cuando se invoca a un servicio backend?
- ¿Por qué la modificación del parámetro backend_timeout no tiene efecto?
- ¿Cómo cambio el entorno para las invocaciones a la API?
- ¿Cuál es el tamaño máximo de un paquete de solicitud de API?
- ¿Cómo realizo la autenticación de aplicaciones en el sistema iOS?
- ¿Por qué no puedo crear un parámetro de encabezado llamado x-auth-token para una API invocada con la autenticación de IAM?
- Preguntas frecuentes sobre credencial
- ¿Pueden las aplicaciones móviles invocar a las API?
- ¿Las aplicaciones desplegadas en una VPC pueden invocar a las API?
- ¿Cómo implemento la transmisión de datos de WebSocket?
- ¿APIG admite las conexiones persistentes?
- ¿Cómo se igualarán y ejecutarán las solicitudes de una API con varias políticas de backend?
- ¿Hay un límite en el tamaño de la respuesta a una solicitud de API?
- ¿Cómo puedo acceder a los servicios backend por las redes públicas con APIG?
-
Autenticación de API
- ¿Admite APIG la autenticación bidireccional de HTTPS?
- ¿Cómo invoco a una API que no requiere autenticación?
- ¿Qué versiones de TLS soporta APIG?
- ¿APIG admite la autenticación personalizada?
- ¿Se firmará el organismo de solicitud para la autenticación de seguridad?
- Errores comunes relacionados con la información de autenticación de IAM
- Políticas de control de API
- Publicación de API
- Importación y exportación de API
- Seguridad de API
-
Otras preguntas frecuentes
- ¿Cuáles son las relaciones entre una API, un entorno y credencial?
- ¿Cómo puedo usar APIG?
- ¿Qué idiomas del SDK admite APIG?
- ¿Puedo cargar archivos con el método POST?
- ¿Cómo son los mensajes de error devueltos por APIG?
- ¿Cómo uso APIG para abrir servicios desplegados en Huawei Cloud?
- ¿Puedo actualizar el gateway compartido a un gateway dedicado?
- ¿Por qué no están disponibles todos los botones de la consola de APIG?
- ¿Se puede desplegar APIG en un centro de datos local?
- Actualmente, el contenido no está disponible en el idioma seleccionado. Sugerimos consultar la versión en inglés.
- What's New
- Function Overview
- Product Bulletin
- Billing
-
Best Practices
- Overview
-
API Openness
- Selectively Exposing CCE Workloads with a Dedicated Gateway
- Selectively Exposing Service Capabilities of a Data Center Using a Dedicated Gateway
- Exposing Backend Services Across VPCs Using a Dedicated Gateway
- Routing gRPC Service Requests Using a Dedicated Gateway
- Forwarding WebSocket Service Requests Using a Dedicated Gateway
- HTTP-to-HTTPS Auto Redirection with a Dedicated Gateway
- Calling Different Backend Services Using a Dedicated Gateway
- API Authentication
- API Policies
- API Security
- 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)
Copiado.
Compra de una puerta de enlace dedicada
Esta sección describe cómo comprar una puerta de enlace dedicada. Puede crear API y usarlas para proporcionar servicios solo después de crear una puerta de enlace dedicada. Si no tiene requisitos de alto rendimiento, omita esta sección y use la puerta de enlace compartida para Crear y gestionar APIs.
Para conocer las diferencias entre las puertas de enlace compartidas y dedicadas, consulte Especificaciones.
Información sobre la compra de una puerta de enlace dedicada
Hay algunas limitaciones en la compra de una puerta de enlace dedicada. Si no puede comprar una puerta de enlace dedicada o no se puede crear una puerta de enlace, compruebe los siguientes elementos:
- Cuota de puerta de enlace
De forma predeterminada, su cuenta se puede utilizar para crear cinco puertas de enlace dedicadas en un proyecto. Para crear más puertas de enlace dedicadas, envíe un ticket de servicio para aumentar la cuota.
- Permisos
Se deben asignar los roles de APIG Administrator y VPC Administrator o asignarse la política de APIG FullAccess para comprar una puerta de enlace dedicada.
También se pueden conceder permisos mediante políticas personalizadas. Para más detalles, consulte Políticas personalizadas de API Gateway.
- Número de direcciones IP privadas disponibles en la subred
Las ediciones básica, profesional, empresarial y platino de API Gateway requieren 3, 5, 6 y 7 direcciones IP privadas en una subred, respectivamente. Asegúrese de que la subred que elija tiene suficientes direcciones IP privadas en la consola de Virtual Private Cloud (VPC).
Entorno de red
- VPC
Las puertas de enlace dedicadas se implementan en las VPC. Los recursos en la nube, como Elastic Cloud Servers (ECSs), en la misma VPC pueden llamar a las API mediante la dirección IP privada de la puerta de enlace dedicada implementada en la VPC.
Se recomienda implementar sus puertas de enlace dedicadas en la misma VPC que sus otros servicios para facilitar la configuración de la red y el acceso seguro a la red.
NOTA:
Las VPC de las puertas de enlace dedicadas no se pueden modificar.
- EIP
Para permitir el acceso público entrante a las API desplegadas en una puerta de enlace dedicada, compre una IP elástica (EIP) y vincúlela a la puerta de enlace dedicada.
NOTA:
Para las API cuyos servicios de backend se implementan en una red pública, API Gateway genera automáticamente una dirección IP para el acceso público saliente y no es necesario comprar un EIP.
- Grupo de seguridad
Similar a un firewall, un grupo de seguridad controla el acceso a una pasarela a través de un puerto específico y la transmisión de datos de comunicación desde la pasarela a una dirección de destino específica. Por motivos de seguridad, cree reglas de entrada para el grupo de seguridad para permitir el acceso solo en puertos específicos.
El grupo de seguridad vinculado a una puerta de enlace dedicada debe cumplir los siguientes requisitos:
- Acceso entrante: Para permitir el acceso a las API de la puerta de enlace dedicada a través de redes públicas o desde otros grupos de seguridad, agregue reglas entrantes para el grupo de seguridad para permitir el acceso en los puertos 80 (HTTP) y 443 (HTTPS).
- Acceso saliente: si el servicio backend de una API se implementa en una red pública o en otro grupo de seguridad, agregue reglas salientes para el grupo de seguridad para permitir el acceso a la dirección del servicio backend a través del puerto de llamada a la API.
- Si los servicios front-end y back-end de una API están vinculados con el mismo grupo de seguridad y VPC que la puerta de enlace dedicada, no se necesitan reglas entrantes o salientes para permitir el acceso a través de los puertos anteriores.
Procedimiento
- Inicie sesión en la consola de gestión.
- Haga clic en
en la esquina superior izquierda y seleccione una región.
- Haz clic en
en la esquina superior izquierda y elige API Gateway.
- En el panel de navegación, elija Dedicated Gateways.
- Haga clic en Buy Dedicated Gateway.
Tabla 1 Parámetros para crear una puerta de enlace dedicada Parámetro
Descripción
Billing Mode
Modo de facturación de la puerta de enlace dedicada. Actualmente, solo se admite la facturación de pago por uso.
Region
Un área geográfica donde se desplegará la puerta de enlace. Implemente la puerta de enlace en la misma región que los otros servicios para permitir que todos los servicios se comuniquen entre sí a través de subredes dentro de una VPC. Esto reduce los costos de ancho de banda público y la latencia de la red.
AZ
Una región física en la que los recursos utilizan redes y fuentes de alimentación independientes. Las zonas de disponibilidad (AZs) están físicamente aisladas pero interconectadas a través de una red interna.
Para mejorar la disponibilidad de la puerta de enlace, implemente la puerta de enlace en varias Zonas de disponibilidad.
Gateway Name
Nombre de la puerta de enlace.
Edition
Las ediciones básicas, profesionales, empresariales y platino están disponibles. El número de solicitudes simultáneas permitidas varía dependiendo de la edición de la puerta de enlace. Para obtener más información, consulte Especificaciones.
Scheduled Maintenance
Período de tiempo en el que se puede mantener la puerta de enlace. El personal de soporte técnico se pondrá en contacto con usted antes del mantenimiento.
Seleccione un período de tiempo con demandas de servicio bajas.
Enterprise Project
Seleccione un proyecto de empresa al que pertenece la puerta de enlace dedicada. Este parámetro solo está disponible si su cuenta es una cuenta de empresa.
Para obtener más información sobre el uso de recursos, la migración y los permisos de usuario de proyectos de empresa, consulte Guía de usuario de gestión de empresa.
Public Inbound Access
Determine si permite que los servicios externos que utilizan un EIP llamen a las API creadas en la puerta de enlace dedicada. Para habilitar esta función, asigne un EIP a la puerta de enlace dedicada. Tendrá que pagar por usar el EIP.
Las API en la puerta de enlace dedicada se pueden llamar usando nombres de dominio independientes o nombres de subdominio. Existe una limitación en el número de veces que se pueden llamar a las API de un grupo de API por día usando el nombre de subdominio. Para superar la limitación, vincular nombres de dominio independientes al grupo de API y asegurarse de que los nombres de dominio independientes ya han sido CNAMEd al EIP de la puerta de enlace dedicada a la que pertenece el grupo de API.
Por ejemplo, tiene una API HTTPS (ruta: /apidemo) con acceso público habilitado. La API se puede llamar usando "https://{domain}/apidemo", donde domain indica un nombre de dominio independiente enlazado al grupo API al que pertenece la API. El nombre de dominio independiente ya debe haber sido CNAMEd al EIP de la puerta de enlace dedicada. El puerto predeterminado es 443.
Public Outbound Access
Determine si desea permitir que los servicios de backend de las API creadas en la puerta de enlace dedicada se implementen en redes públicas. Si habilita esta opción, establezca un ancho de banda que cumpla con sus requisitos de servicio. El ancho de banda oscila entre 1 y 2000 Mbit/s y se facturará por hora según el precio del servicio EIP.
IPv6
Este parámetro solo está disponible cuando se establece el modo de facturación en Pago por uso.
Si el servicio backend de una API se implementa en una red pública y solo se puede acceder mediante una dirección IPv6, seleccione IPv6 Access.
NOTA:
Esta función solo está disponible en ciertas regiones.
Network
Seleccione una VPC y una subred para la puerta de enlace dedicada.
Los recursos de la nube (como los ECS) dentro de la misma VPC pueden llamar a las API mediante la dirección IP privada de la puerta de enlace dedicada.
Implemente la puerta de enlace dedicada en la misma VPC que sus otros servicios para facilitar la configuración de la red y el acceso seguro a la red.
Security Group
Seleccione un grupo de seguridad para controlar el acceso entrante y saliente.
Si el servicio de backend de una API se implementa en una red externa, configure las reglas de grupo de seguridad para permitir el acceso a la dirección de servicio de backend a través del puerto de llamada de API.
NOTA:
Si el acceso público entrante está habilitado, agregue reglas entrantes para el grupo de seguridad para permitir el acceso en los puertos 80 (HTTP) y 443 (HTTPS).
Description
Descripción de la puerta de enlace.
- Haga clic en Next.
- Compruebe la configuración de la puerta de enlace, lea y confirme su aceptación del acuerdo del cliente y la declaración de privacidad, y haga clic en Pay Now. El progreso de la creación de la puerta de enlace se muestra en la pantalla.
Si establece el modo de facturación en Yearly/monthly, la puerta de enlace dedicada solo se creará después de realizar el pago.
Operaciones de seguimiento
Una vez creada la puerta de enlace, puede crear y gestionar APIs en la consola de la puerta de enlace. La página Gateway Information muestra los detalles de la puerta de enlace, las configuraciones de red, los recursos de API y las métricas.
Puede modificar el nombre de la puerta de enlace, la descripción, la ventana de tiempo de mantenimiento programado, el grupo de seguridad y el EIP.
Cambio del modo de facturación de una puerta de enlace dedicada
Puede cambiar el modo de facturación de las puertas de enlace dedicadas de yearly/monthly a pay-per-use o de pay-per-use a yearly/monthly. El modo de facturación se puede cambiar de anual/mensual a pago por uso solo cuando las suscripciones de la puerta de enlace hayan caducado.
- En el panel de navegación, elija Dedicated Gateways.
- Haga clic en More junto a la puerta de enlace de destino y haga clic en Change to Yearly/Monthly o Change to Pay-per-Use.
- Cambiar a anual/mensual: Seleccione una duración de renovación y haga clic en Pay.
- Cambiar a pago por uso: haga clic en Change to Pay-per-Use antes de que caduque la suscripción de la puerta de enlace o durante el período congelado después de que caduque. El cambio entra en vigor solo después de que la suscripción haya caducado.