Summary

最終更新日: Apr 04, 2018

Thank you for choosing Alibaba Cloud API Gateway service. You can use the APIs described in this document to perform relevant operations on the API Gateway service.

Before using these interfaces, make sure you fully understand the API Gateway service instructions, user agreements, and billing methods.

Glossary

Term Full name Description
Region - The region that you select on the API Gateway to deploy an API. We recommend that you select the region where your backend services are located.
API - The API that you enter on the API Gateway to deploy the API and provide services or data externally through the API.
Group API Group A group of APIs.
  • An API group that you create and deploy APIs.
  • Each API group has a second-level domain name and two stages.
  • You must bind an independent domain name to the API group after the independent domain name is filed and resolved to the second-level domain name of the API group.
  • The APIs in the same group can be accessed using the bound independent domain name.
SubDomain - Each API group that you create for deploying APIs has a second-level domain name. An independent domain name must be resolved to the second-level domain name, which can be accessed directly to call the APIs in the test stage.
CustomDomain Custom Domain An independent domain name that you bind to deploy an API. The CNAME of the independent domain name must be resolved to the second-level domain name of an API group, and the independent domain name must be filed to Alibaba Cloud or filed for access. For HTTPS support, must upload an SSL compliance certificate for the domain name.
Stage - The two stages, test and online, of each API group that you create to deploy APIs. Only APIs that are manually released to a stage can be called. By default, APIs in the test stage are called by directly accessing the second-level domain name of the API group.
Signature Backend Signature An authentication key that you grant to the API Gateway to deploy an API. After being bound to APIs, the backend signature key takes effect for those APIs instantly. When receiving requests from the APIs, the API Gateway requests backend services by carrying the signature information, which is used by the backend services to authenticate the API Gateway.
TrafficControl - The throttling that you select to deploy an API. After being bound to APIs, throttling policies take effect for those APIs instantly. The policies manage API calls from three dimensions: API, app, and user. You can configure special throttling policies under throttling policies. For example, when an app or user calls the APIs bound with special throttling policies, throttling is performed on API access based on special values.
Special Special Throttling "Special" is configured under "TrafficControl", and is used to perform throttling on access to the APIs bound with throttling policies based on separate values applied to a specified app or user.
App - The app that you create as an identity to call an API deployed by another user. When the API Gateway receives a request, it performs signature verification using the AppKey and AppSecret.

Business restrictions and type constraints

The API Gateway imposes limits on the numbers of API groups and APIs that you can create, and the APIs that you can call through the API Gateway. For more information about the use restrictions, see the Open API Use Restrictions and API Call Restrictions.

In the interface description section, whenever a conflict with the preceding documents occurs, the information in the documents prevails.