API Gateway
API Gateway
All results for "
" in this service
All results for "
" in this service
What's New
Function Overview
Product Bulletin
Product Bulletin
Action Change Notice
Vulnerability Notices
Vulnerability Fixing Policies
Service Overview
APIG Infographics
What Is APIG?
Product Advantages
Application Scenarios
Specifications
Security
Shared Responsibilities
Identity Authentication and Access Control
Data Protection
Audit and Logs
Security Risk Monitoring
Certificates
Notes and Constraints
Permissions Management
Basic Concepts
Billing
Overview
Billing Modes
Introduction
Pay-per-Use
Billing Items
Bills
Arrears
Stopping Billing
Cost Management
Getting Started
Quickly Opening and Calling APIs
Getting Started with Common Practices
User Guide
Process of Using APIG
Creating a User and Granting APIG Permissions
Creating a Gateway
Opening APIs
Process Flow
Creating an API Group
Adding an SSL Certificate for an API
Configuring the Domain Name for Calling APIs
(Optional) Creating a Load Balance Channel
Creating an API
Creating a REST API
Creating a gRPC API
Debugging an API
(Optional) Configuring the Environment and Environment Variables
Publishing an API
(Optional) Configuring Authorization for API Calling
API Authorization Overview
Configuring Authentication Credentials
Configuring AppCodes for Simple Authentication
Calling APIs
Calling an Open API
CORS Calling of an Open API
Response Headers
Error Codes
Managing APIs
Overview
Viewing or Modifying API Information
Configuring Custom API Authentication
Creating a Frontend Custom Authorizer
Creating a Backend Custom Authorizer
Configuring API Parameter Orchestration Rules
Customizing Error Response for APIs
Cloning an API
Taking an API Offline
Importing and Exporting APIs
Restrictions and Compatibility of Importing and Exporting APIs
Importing APIs through an API Design File
Importing APIs Through CSE Microservices
Importing APIs Through CCE Workloads
Exporting APIs
API Design File Extension Definitions
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
x-apigateway-auth-opt
x-apigateway-result-normal-sample
x-apigateway-result-failure-sample
x-apigateway-authorizer
x-apigateway-response
x-apigateway-responses
x-apigateway-pass-through
x-apigateway-sample
x-apigateway-content-type
x-apigateway-orchestrations
Configuring API Policies
Configuring Traditional API Policies
Configuring API Request Throttling
Configuring API Access Control
Configuring Signature Verification for Backend Services
Configuring API Plug-in Policies
CORS
Proxy Cache
HTTP Response Header Management
Request Throttling 2.0
Kafka Log Push
Circuit Breaker
Third-Party Authorizer
Proxy Mirror
OIDC Authentication
Configuring a Credential Policy
Credential Quota Policy
Credential Access Control Policy
Managing APIG Gateways
Viewing or Modifying Gateway Information
Configuring Gateway Parameters
Configuring Gateway Tags
Configuring Gateway VPC Endpoints
Customizing Gateway Inbound Ports
Modifying Gateway Specifications
Viewing Metrics and Configuring Alarms
Monitoring Metrics
Configuring an Alarm Rule
Viewing Metrics
Viewing Bandwidth Monitoring
Viewing API Call Logs
Viewing Audit Logs
APIG Operations Recorded by CTS
Viewing CTS Traces in the Trace List
Shared Gateway (for Existing Users)
Using APIG
Accessing the Shared 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
Monitoring
APIG 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
SDKs
Purchased APIs
Calling Published APIs
Calling APIs
Response Headers
Error Codes
Key Operations Recorded by CTS
APIG operations that can be recorded by CTS
Viewing CTS Traces in the Trace List
Best Practices
Overview
API Openness
Selectively Exposing CCE Workloads with a Dedicated Gateway
Introduction
Resource Planning
General Procedure
Implementation Procedure
Preparing a CCE Workload
Method 1: Opening a CCE Workload by Creating a Load Balance Channel
Method 2: Opening a CCE Workload by Importing It
(Optional) Configuring Workload Labels for Grayscale Release
Selectively Exposing Service Capabilities of a Data Center Using a Dedicated Gateway
Exposing Backend Services Across VPCs Using a Dedicated Gateway
Introduction
Resource Planning
General Procedure
Implementation Procedure
Routing gRPC Service Requests Using a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
Forwarding WebSocket Service Requests Using a Dedicated Gateway
HTTP-to-HTTPS Auto Redirection with a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
Calling Different Backend Services Using a Dedicated Gateway
Introduction
General Procedure
Implementation Procedure
Configuring a FunctionGraph Backend for a Dedicated Gateway
API Authentication
Developing a Custom Authorizer with FunctionGraph
Configuring Two-factor Authentication (App + Custom)
Configuring One-Way or Two-Way Authentication Between the Dedicated Gateway and Client
API Policies
Using Request Throttling 2.0 for Fine-grained Request Throttling
Introduction
General Procedure
Implementation Procedure
API Security
Using WAF to Protect APIG
APIG Security Best Practices
Version Migration
Migrating Shared Gateway to a Dedicated Gateway
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#
API Reference
Before You Start
API Overview
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 API 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
Querying the Number of Gateways with a Specified Tag
Querying Gateways by Tag
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
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
Orchestration Rule Management
Creating an Orchestration Rule
Viewing Orchestration Rules
Querying Rule Details
Updating an Orchestration Rule
Deleting an Orchestration Rule
Querying APIs to Which an Orchestration Rule Is Bound
Gateway Custom Inbound Port Management
Querying the Domain Name Bound to a Custom Inbound Port
Querying the Custom Inbound Ports of a Gateway
Adding an Inbound Port for a Gateway
Deleting an Inbound Port of a Gateway
Shared Gateway APIs (for Existing Users)
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
Creating 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
Creating an AppCode
Generating an AppCode
Querying AppCode Details
Querying an AppCode List
Deleting an AppCode
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 KooGallery
Querying the List of Purchased API Groups
Querying Details of a Purchased API Group
Querying the List of Purchased APIs
Configuration Management
Object Model
Querying Configuration Details
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)
Querying Metrics
Querying API Calls Within a Period
Querying API Calls Under an API Group in the Last One Hour
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
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
Data Structure (Plugin Content Definition)
CorsPluginContent
SetRespHeadersContent
KafkaLogContent
BreakerContent
RateLimitContent
ThirdAuthContent
ProxyCacheContent
ProxyMirrorContent
Change History
SDK Reference
SDK Overview
FAQs
Common FAQs
Product Consulting FAQs
What Are the Relationships Between an API, Environment, and Credential?
Can I Upgrade the Shared Gateway to a Dedicated Gateway?
Why All Buttons on the APIG Console Cannot Be Clicked?
How Do I Ensure API Calling Security?
How Do I Ensure the Security of Backend Services Invoked by APIG?
Opening APIs
Why Can't I Create APIs?
How Do I Define Response Codes for an API?
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?
Can I Bind Private Domain Names for API Access?
Why Do I Fail to Call an API Across Domains?
How Do I Use APIG to Open Up Services Deployed on Huawei Cloud?
Publishing an API
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?
Calling APIs
What Are the Possible Causes for an API Calling Failure?
Why Am I Seeing the Error Message "414 Request URI too large" When I Call an API?
Why Am I Seeing the Error Message "The API does not exist or has not been published in the environment" When I Call an API?
Why Am I Seeing the Error Message "No backend available" When I Call an API?
Why Am I Seeing the Error Message "Backend unavailable" or "Backend timeout" When I Invoke the Backend Service?
Why Am I Seeing the Error Message "Backend domain name resolution failed" When I Invoke the Backend Service?
Why Am I Seeing the Error Message "Incorrect IAM authentication information" When I Call an API?
Why Am I Seeing the Error Message "Incorrect app authentication information" When I Call an API?
Why Doesn't Modification of the backend_timeout Parameter Take Effect?
Does APIG Have a Limit on the Size of the API Request Body?
Is There a Limit on the Size of the Response to an API Request?
How Do I Call an API Using App Authentication in iOS System?
Why Can't I Create a Header Parameter Named x-auth-token for an API Called Through IAM Authentication?
Can Mobile Apps Call APIs?
Can Applications Deployed in a VPC Call APIs?
Does APIG Support WebSocket Data Transmission?
How Will the Requests for an API with Multiple Backend Policies Be Matched and Executed?
How Can I Access Backend Services over Public Networks Through APIG?
API Authentication
Does APIG Support Two-Way Authentication?
Will the Request Body Be Signed?
API Credential FAQs
API Policies
Can I Configure the Maximum Number of Concurrent Requests?
Is the Restriction of 1,000 Requests Per Day to a Debugging Domain Name Applied to Enterprise Accounts?
Does APIG Have Bandwidth Limits?
Why Doesn't a Request Throttling Policy Take Effect?
How Do I Provide an Open API to Specific Users?
Are Client IP Addresses Verified for Access Control?
Importing and Exporting APIs
What Are the Possible Causes of an API Import Failure?
Is There a Template for Importing APIs Using a Swagger File?
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
General Reference
Glossary
Service Level Agreement
White Papers
Endpoints
Permissions