API Gateway
API Gateway
All results for "
" in this service
All results for "
" in this service
What's New
Function Overview
Product Bulletin
Vulnerability Notices
Vulnerability Fixing Policies
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 an App and Getting Authorized
Adding an AppCode for Simple Authentication
Calling an API
User Guide
Overview
Gateway Management
Creating a Dedicated Gateway
Modifying a Dedicated Gateway
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
Plug-ins
Creating a Plug-in
CORS Plug-in
HTTP Response Header Management Plug-in
Deleting a Plug-in
Monitoring
API Gateway Metrics
Creating Alarm Rules
Viewing Metrics
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
Log Analysis
SDKs
Calling Published APIs
Calling APIs
Response Headers
Error Codes
Permissions Management
Creating a User and Granting API Gateway Permissions
API Gateway Custom Policies
Key Operations Recorded by CTS
API Gateway operations that can be recorded by CTS
Querying Audit Logs
Developer Guide
Overview
Authentication Mode Selection
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
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
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
API Reference
Before You Start
Overview
API Calling
Endpoints
Constraints
Concepts
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
Registering 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 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
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
SDK Reference
SDK Overview
Best Practices
Selectively Exposing CCE Workloads
Selectively Exposing Service Capabilities of a Data Center
Exposing Backend Services Across VPCs
Introduction
Resource Planning
General Procedure
Implementation Procedure
Interconnecting with WAF
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 FAQs
Can Mobile Apps Call APIs?
Can Applications Deployed in a VPC Call APIs?
How Do I Implement 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 to a Subdomain Name Applied to Enterprise Accounts?
Does APIG Has 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?
API Publishing
Do I Need to Publish an API Again After Modification?
Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?
Can I Invoke Different Backend Services by Publishing an API in Different Environments?
How Do 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?
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?
How Do I Use APIG to Open Up Services Deployed on Huawei Cloud?
Can APIG Be Deployed in a Local Data Center?
Videos