All Products
Search
Document Center

API Gateway:API overview

Last Updated:Jun 29, 2026

API standards and multilingual preset SDKs

The OpenAPI of this product (CloudAPI/2016-07-14) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Private domain resolution

API

Title

Description

DissociateInstanceWithPrivateDNS DissociateInstanceWithPrivateDNS Disassociates an internal domain name resolution from a dedicated instance.
DeletePrivateDNS DeletePrivateDNS Deletes an internal domain name resolution.
AssociateInstanceWithPrivateDNS AssociateInstanceWithPrivateDNS Associates an internal domain name resolution with a dedicated instance.
CreatePrivateDNS CreatePrivateDNS Creates an internal domain name resolution and adds a resolution record.
ListPrivateDNS ListPrivateDNS Queries the resolution settings for private domain names. You can filter the query by private domain name or resolution type.
UpdatePrivateDNS UpdatePrivateDNS Modifies an internal domain name resolution.

Instances

API

Title

Description

ModifyInstanceVpcAttributeForConsole Modify instance client VPC config Modify instance client VPC config.
CreateInstance CreateInstance Creates an API Gateway instance.
DeleteInstance DeleteInstance Deletes an API Gateway instance. You can use this operation only to delete pay-as-you-go instances. To delete subscription instances, use the console.
ModifyInstanceAttribute ModifyInstanceAttribute Modifies the properties of an API Gateway instance.
ModifyInstanceSpec ModifyInstanceSpec Upgrades or downgrades the configurations of an API Gateway instance.
EnableInstanceAccessControl EnableInstanceAccessControl This feature provides instance-level access control capabilities for dedicated API Gateway instances. Specifies the access control policy of an instance.
DisableInstanceAccessControl DisableInstanceAccessControl This feature provides instance-level access control capabilities for dedicated API Gateway instances. Disables access control on an instance.
DescribeInstances DescribeInstances Describes the details of one or more shared or dedicated instances in a region.

Groups

API

Title

Description

ModifyIntranetDomainPolicy ModifyIntranetDomainPolicy Modifies the VPC domain name policy of an API group.
CreateApiGroup CreateApiGroup Create an API group.
DeleteApiGroup DeleteApiGroup Deletes an API group.
ModifyApiGroup ModifyApiGroup Modifies the name, description, or base path of an existing API group.
DescribeApiGroup DescribeApiGroup Queries a specified API group, including its system-generated second-level domain name, custom domain names, and SSL Certificate information.
DescribeApiGroups DescribeApiGroups Queries existing API groups and their basic information.
DescribePurchasedApiGroup DescribePurchasedApiGroup Queries the details about an API group purchased from Alibaba Cloud Marketplace.
DescribePurchasedApiGroups DescribePurchasedApiGroups Queries the API groups purchased from Alibaba Cloud Marketplace.

Domains

API

Title

Description

DeleteDomain DeleteDomain Unbinds a custom domain name from an API group.
DeleteDomainCertificate DeleteDomainCertificate Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation.
SetDomain SetDomain Binds a custom domain name to a specified API group.
SetDomainCertificate SetDomainCertificate Uploads an SSL certificate for a specified custom domain name.
SetDomainWebSocketStatus SetDomainWebSocketStatus Enables or disables WebSocket for a custom domain name.
SetWildcardDomainPatterns SetWildcardDomainPatterns Specifies a wildcard domain name template for a bound custom domain name.
DescribeDomain DescribeDomain Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.
ReactivateDomain ReactivateDomain Reactivates a custom domain name whose validity status is Abnormal.

Monitoring

API

Title

Description

CreateMonitorGroup CreateMonitorGroup Enables CloudMonitor alerting for a specified API group.
DeleteMonitorGroup DeleteMonitorGroup Deletes a CloudMonitor application group corresponding to an API group.
DescribeApiLatencyData DescribeApiLatencyData Queries the response time statistics of an API.
DescribeApiQpsData DescribeApiQpsData Queries the QPS statistics of an API.
DescribeApiTrafficControls DescribeApiTrafficControls Queries the throttling policies bound to all members of an API group in a specified environment.
DescribeApiTrafficData DescribeApiTrafficData Queries the statistics on the traffic of an API.
DescribeInstanceDropPacket DescribeInstanceDropPacket Queries the number of dropped packets within a period of time.
DescribeInstanceDropConnections DescribeInstanceDropConnections Queries the number of lost connections to a dedicated instance within a period of time.
DescribeInstanceHttpCode DescribeInstanceHttpCode Queries the distribution of HTTP status codes of requests to a dedicated instance within a period of time.
DescribeInstanceLatency DescribeInstanceLatency Queries the average latency of a dedicated instance over a period of time.
DescribeInstanceNewConnections DescribeInstanceNewConnections Queries the number of new connections to a dedicated instance within a period of time.
DescribeInstancePackets DescribeInstancePackets Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time.
DescribeInstanceQps DescribeInstanceQps Queries the number of requests to a dedicated instance within a period of time.
DescribeInstanceSlbConnect DescribeInstanceSlbConnect Queries the number of concurrent connections to a dedicated instance within a period of time.
DescribeInstanceTraffic DescribeInstanceTraffic Queries the request traffic and response traffic of a dedicated instance within a period of time.
DescribeGroupQps DescribeGroupQps Queries the statistics on the number of requests directed to an API group within a period of time.

API management

API

Title

Description

CreateApi CreateApi Creates an API.
CreateApiStageVariable CreateApiStageVariable Adds a variable to an environment.
ImportOAS ImportOAS Imports OpenAPI Specification (OAS)-compliant data to create an API.
ImportSwagger ImportSwagger Creates an API by importing Swagger-compliant data.
DeleteApi DeleteApi Deletes the definition of a specified API.
DeleteApiStageVariable DeleteApiStageVariable Deletes a specified variable in a specified environment.
ModifyApiConfiguration ModifyApiConfiguration This API operation is used to modify the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you need to only specify the value of AuthType, which is APP.
ModifyApi ModifyApi Modifies the definition of an API.
DescribeApisByBackend DescribeApisByBackend Queries APIs in the draft or published state that are created by using a specified backend service.
DescribeApi DescribeApi Queries the definition of a specified API.
DescribeApiMarketAttributes DescribeApiMarketAttributes Queries the Alibaba Cloud Marketplace attributes of an API.
DescribeApis DescribeApis Queries a list of APIs that are being defined.
DescribeApiHistory DescribeApiHistory Queries a specified historical version of a specified API definition.
DescribeApisByApp DescribeApisByApp Queries the APIs with which an application is associated.
DescribeAuthorizedApis DescribeAuthorizedApis Queries the authorized APIs of a specified APP.
DescribeApiDoc DescribeApiDoc Queries the documentation of an API.
DescribeDeployedApi DescribeDeployedApi Queries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited.
DescribeHistoryApis DescribeHistoryApis Queries the historical versions of an API.
DescribeImportOASTask DescribeImportOASTask Queries the result of an OAS API import task.
DescribePurchasedApis DescribePurchasedApis Queries the APIs purchased in the Alibaba Cloud Marketplace.
DescribeApiHistories DescribeApiHistories Queries the historical versions of a specified API.
DescribeDeployedApis DescribeDeployedApis Queries the APIs that have been published to a specified environment.
DescribeMarketRemainsQuota DescribeMarketRemainsQuota Queries the number of remaining ordered relationships for a purchaser.
DescribeDeployApiTask DescribeDeployApiTask Queries the progress of an asynchronous API publishing task.
DescribeAbolishApiTask DescribeAbolishApiTask Queries the progress of an API unpublishing task.
AbolishApi AbolishApi Unpublishes a specified API from a specified runtime environment.
DeployApi DeployApi Publishes an API to a specified environment.
BatchDeployApis BatchDeployApis Publishes multiple APIs at a time.
BatchAbolishApis BatchAbolishApis Unpublishes multiple published APIs at a time.
SwitchApi SwitchApi Switches the definition of an API in a specified runtime environment to a historical version.
DryRunSwagger DryRunSwagger Checks the syntax before Swagger-compliant data is imported.

Applications

API

Title

Description

CreateApp CreateApp Creates an app for API Gateway.
DeleteApp DeleteApp Deletes a specified app.
ModifyApp ModifyApp Modifies a specified application.
DescribeApps DescribeApps Queries the apps of a user. App information is returned only to the app owner.
DescribeAppAttributes DescribeAppAttributes Query the list of applications and their basic information.
DescribeAuthorizedApps DescribeAuthorizedApps Queries the current apps.
DescribeApp DescribeApp This operation queries the list of Apps available for authorization and fetches App information for developers during authorization operations.
DescribeAppSecurity DescribeAppSecurity This key is used for authentication when an API call is made.
ResetAppCode Reset an application Resets the AppCode of an application. This operation can be called only once per minute for each user.

VPCs

API

Title

Description

RemoveVpcAccess RemoveVpcAccess Deletes a VPC access authorization without unpublishing the associated APIs.
RemoveVpcAccessAndAbolishApis RemoveVpcAccessAndAbolishApis Removes a VPC authorization and unpublishes the associated APIs.
ModifyVpcAccessAndUpdateApis ModifyVpcAccessAndUpdateApis Modifies the information of a VPC access authorization and updates the metadata of the associated API.
ModifyApiGroupVpcWhitelist ModifyApiGroupVpcWhitelist Modifies the VPC whitelist of an API group.
SetVpcAccess SetVpcAccess Creates a virtual private cloud (VPC) access authorization and enables reverse access.
DescribeApiGroupVpcWhitelist DescribeApiGroupVpcWhitelist Queries the VPC whitelist that is allowed to access an API group.
DescribeVpcAccesses DescribeVpcAccesses Queries VPC access authorizations.
DescribeUpdateVpcInfoTask DescribeUpdateVpcInfoTask When you update Virtual Private Cloud (VPC) authorization, the associated published APIs are updated asynchronously. retrieve the progress of those updates.
ValidateVpcConnectivity ValidateVpcConnectivity Tests the network connectivity between an API Gateway instance and a port on an Elastic Compute Service (ECS) or Server Load Balance (SLB) instance in a virtual private cloud (VPC) access authorization.

Access control policies

API

Title

Description

CreateAccessControlList CreateAccessControlList This feature provides instance-level access control capabilities for dedicated instances. Creates an Access Control List (ACL). Each user is allowed to create five ACLs in each region.
DeleteAccessControlList DeleteAccessControlList This feature provides instance-level access control capabilities for dedicated instances. Deletes an access control policy.
SetAccessControlListAttribute SetAccessControlListAttribute This feature provides instance-level access control for API Gateway exclusive instances and lets you modify the access control policy name.
AddAccessControlListEntry AddAccessControlListEntry This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance.
RemoveAccessControlListEntry RemoveAccessControlListEntry This operation removes IP address entries from the access control policy of a dedicated API Gateway instance.
DescribeAccessControlListAttribute DescribeAccessControlListAttribute This feature provides instance-level access control for dedicated instances. Queries an access control policy.
DescribeAccessControlLists DescribeAccessControlLists This feature provides instance-level access control for dedicated instances. Queries access control policies.

Plug-ins

API

Title

Description

DetachGroupPlugin Unbind the plugin from the group Unbind group plugin
AttachGroupPlugin Attach plugin to group Attach plugin to API group.
DescribePluginsByGroup Query Plugins Bound to API Group Query Plugins Bound to API Group
DescribePluginGroups Query the List of Groups Bound to a Plugin Query the list of groups bound to a plugin based on the plugin ID
CreatePlugin CreatePlugin Creates a plug-in.
DeletePlugin DeletePlugin Deletes a plug-in.
AttachPlugin AttachPlugin Binds a plug-in to an API.
ModifyPlugin ModifyPlugin Modifies the information of a plug-in.
DetachPlugin DetachPlugin Detaches a plugin from an API.
DescribePluginApis DescribePluginApis Queries the APIs to which a specified plug-in is bound.
DescribePluginsByApi DescribePluginsByApi Queries the plug-ins that are bound to a running API in a specified environment.
DescribePluginSchemas DescribePluginSchemas Describes the schemas for plug-ins supported by API Gateway.
DescribePluginTemplates DescribePluginTemplates Query plugin templates
DescribePlugins DescribePlugins Queries API Gateway plug-ins and the details of the plug-ins.

Custom datasets

API

Title

Description

CreateDataset CreateDataset Creates a custom dataset.
CreateDatasetItem CreateDatasetItem Create a data item for a custom dataset.
DeleteDataset DeleteDataset Deletes a custom dataset.
DeleteDatasetItem DeleteDatasetItem Deletes a data entry from a custom dataset.
ModifyDataset ModifyDataset Modifies the name of a custom dataset.
ModifyDatasetItem ModifyDatasetItem Modifies the timeout period and description of a data entry in a custom dataset.
DescribeDatasetInfo DescribeDatasetInfo Returns information about a single dataset.
DescribeDatasetList DescribeDatasetList Retrieves the list of custom datasets.
DescribeDatasetItemInfo DescribeDatasetItemInfo Queries a data entry in a custom dataset.
DescribeDatasetItemList DescribeDatasetItemList Queries the data entries of a custom dataset.

Models

API

Title

Description

CreateModel CreateModel Creates a model for an API group.
DeleteModel DeleteModel Deletes a model.
ModifyModel ModifyModel Updates the model of an API group.
DescribeModels DescribeModels Queries the created models of an API group.

Permissions

API

Title

Description

SetApisAuthorities SetApisAuthorities Authorizes a specified application to call multiple APIs.
SetAppsAuthorities SetAppsAuthorities Grants access permissions on a specified API to multiple applications.
RemoveApisAuthorities RemoveApisAuthorities Revokes the access permissions on multiple APIs from a specified application.
RemoveAppsAuthorities RemoveAppsAuthorities Revokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API.
ResetAppSecret ResetAppSecret Resets the key for an app.

Tags

API

Title

Description

ListTagResources ListTagResources Query visible resource-tag relationships.
TagResources TagResources Create tag-resource relationships (user tags).
UntagResources UntagResources Removes tags from resources.

Services

API

Title

Description

DescribeSummaryData DescribeSummaryData Queries the number of API Gateway resources in a region.
DescribeRegions DescribeRegions Queries the Alibaba Cloud regions that are supported by API Gateway.
DescribeSystemParameters DescribeSystemParameters Queries the common parameters supported by the system.
DescribeZones DescribeZones Queries zones in a region.
OpenApiGatewayService OpenApiGatewayService Activates the gateway service.

Logs

API

Title

Description

CreateLogConfig CreateLogConfig Creates a Simple Log Service configuration for an API.
DeleteLogConfig DeleteLogConfig Deletes a log configuration.
ModifyLogConfig ModifyLogConfig Modifies the log configuration.
QueryRequestLogs QueryRequestLogs Queries the request logs of a user.
DescribeLogConfig DescribeLogConfig Queries log configurations.

SDK

API

Title

Description

SdkGenerateByAppForRegion SdkGenerateByAppForRegion Generates an SDK for APIs associated with an app.
SdkGenerateByApp SdkGenerateByApp Generates a software development kit (SDK) for an application.
SdkGenerateByGroup SdkGenerateByGroup Generate an SDK by API group.

Backends

API

Title

Description

CreateBackend CreateBackend Creates a backend service in API Gateway.
DeleteBackend DeleteBackend Deletes a backend service.
ModifyBackend ModifyBackend You cannot modify the basic information of a backend service—such as its name, description, or backend service type—after the backend service is created.
DescribeBackendList DescribeBackendList Queries backend services. You can filter backend services by backend service name and backend service type.
DescribeBackendInfo DescribeBackendInfo Query backend service information and the backend addresses configured in each environment.
DescribeUpdateBackendTask DescribeUpdateBackendTask When you modify the definition of a backend service in an environment, all associated published APIs are updated in a batch. You can query the results of the update.

Backend models

API

Title

Description

CreateBackendModel CreateBackendModel Creates a backend service configuration for an environment.
DeleteBackendModel DeleteBackendModel Deletes the definition of a backend service in an environment. After the definition is deleted, the API that uses the backend service and is published to this environment will be unpublished.
ModifyBackendModel ModifyBackendModel This operation modifies the definition of a backend service in an environment. After the modification, the backend addresses of APIs that use this backend service and are published in this environment are batch updated automatically, without requiring manual publishing.

Signature plug-ins (classic network instances)

API

Title

Description

CreateSignature CreateSignature Creates a backend signature key.
DeleteSignature DeleteSignature Deletes a backend signature key.
ModifySignature ModifySignature Modifies a backend signature key.
SetSignatureApis SetSignatureApis Binds a signature key to APIs.
DescribeSignatures DescribeSignatures Queries backend signature keys.
DescribeApisBySignature DescribeApisBySignature Queries the APIs to which a specified backend signature key is bound.
DescribeApiSignatures DescribeApiSignatures Queries the backend signature keys that are bound to the APIs of a specified API group in a specified environment.
DescribeSignaturesByApi DescribeSignaturesByApi Queries the backend signature keys that are bound to a specified API.
RemoveSignatureApis RemoveSignatureApis Unbinds a backend signature key from APIs.

Throttling plug-ins (classic network instances)

API

Title

Description

AddTrafficSpecialControl AddTrafficSpecialControl Adds a custom special policy to a specified throttling policy.
CreateTrafficControl CreateTrafficControl Creates a custom throttling policy.
DeleteAllTrafficSpecialControl DeleteAllTrafficSpecialControl Deletes all custom special policies of a specified throttling policy.
DeleteTrafficControl DeleteTrafficControl Deletes a custom throttling policy and the special throttling rules in the policy.
DeleteTrafficSpecialControl DeleteTrafficSpecialControl Deletes a custom special throttling policy.
ModifyTrafficControl ModifyTrafficControl Modifies settings for a custom throttling policy.
SetTrafficControlApis SetTrafficControlApis Binds a throttling policy to APIs.
DescribeTrafficControls DescribeTrafficControls Queries custom throttling policies and their details. Conditional queries are supported.
DescribeTrafficControlsByApi DescribeTrafficControlsByApi Queries the throttling policy that is bound to a specific API.
DescribeApisByTrafficControl DescribeApisByTrafficControl Queries the APIs to which a specified throttling policy is bound.
RemoveTrafficControlApis RemoveTrafficControlApis Unbinds a specified throttling policy from APIs.

Access control plug-ins (classic network instances)

API

Title

Description

AddIpControlPolicyItem AddIpControlPolicyItem Adds a policy to an existing ACL.
CreateIpControl CreateIpControl Creates an access control list (ACL) in a region.
DeleteIpControl DeleteIpControl Deletes an access control list (ACL).
ModifyIpControl ModifyIpControl Modifies an access control list (ACL).
ModifyIpControlPolicyItem ModifyIpControlPolicyItem Modifies a policy in an access control list (ACL).
SetIpControlApis SetIpControlApis Creates a binding relationship between specified access control lists (ACLs) and APIs.
DescribeApiIpControls DescribeApiIpControls Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment.
DescribeIpControlPolicyItems DescribeIpControlPolicyItems Queries the rule entries of an IP address-based traffic control policy.
DescribeIpControls DescribeIpControls Queries custom access control lists (ACLs) on separate pages.
DescribeApisByIpControl DescribeApisByIpControl Queries the APIs that are bound to an access control list (ACL).
RemoveIpControlApis RemoveIpControlApis Unbinds an API from an access control list (ACL).
RemoveIpControlPolicyItem RemoveIpControlPolicyItem Removes one or more policies from an access control list (ACL).

Others

API

Title

Description

DescribeApisWithStageNameIntegratedByApp DescribeApisWithStageNameIntegratedByApp Queries APIs by application and returns the result by environment.
DescribeGroupLatency DescribeGroupLatency Queries the average latency of an API group in an environment.
DescribeGroupTraffic DescribeGroupTraffic Queries the traffic of an API group.
ModifyApiGroupInstance ModifyApiGroupInstance Modifies a group instance.
ModifyApiGroupNetworkPolicy ModifyApiGroupNetworkPolicy Modifies the network policy of an API group.
DetachApiProduct DetachApiProduct Detaches APIs from an API product.
SetApiProductsAuthorities SetApiProductsAuthorities Grants permissions on API products to an application.
DescribeApiProductsByApp DescribeApiProductsByApp Queries API products by application.
DescribeApiProductApis DescribeApiProductApis Queries the attached APIs of an API product.
DescribeAppsByApiProduct DescribeAppsByApiProduct Queries authorized applications by API product.
AttachApiProduct AttachApiProduct Attaches APIs to an API product. If the API product does not exist, the system automatically creates the API product.
DeleteApiProduct DeleteApiProduct Deletes an API product. Deleting an API product causes the association between APIs and the deleted API product to be deleted as well. Exercise caution when you delete an API product. If any API in the API product is associated with an application, the API product fails to be deleted.
RemoveApiProductsAuthorities RemoveApiProductsAuthorities Revokes permissions on API products from an application.
SetAppsAuthToApiProduct SetAppsAuthToApiProduct Authorizes multiple applications to call APIs in an API product.
DescribeApisByVpcAccess DescribeApisByVpcAccess Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region.
DeleteAppCode DeleteAppCode Deletes the AppCode of an application.
DeleteAppKey DeleteAppKey Deletes the AppKey and AppSecret of an application.
CreateAppCode CreateAppCode Adds an AppCode to an application.
CreateAppKey CreateAppKey Adds an AppKey and AppSecret pair to an application.
DescribeInstanceClusterInfo DescribeInstanceClusterInfo Queries the information about a dedicated instance cluster.
DescribeInstanceClusterList DescribeInstanceClusterList Queries dedicated instance clusters.
DescribeAppSecurities DescribeAppSecurities Queries the key-related information of an application.
ExportOAS ExportOAS Exports APIs based on OpenAPI Specification (OAS).

Others

API

Title

Description

CreateStageModel CreateStageModel Creates a stage model.
DeleteStageModel DeleteStageModel Deletes a stage model.
DescribeStageModels DescribeStageModels Retrieves a list of stage models.
ModifyStageModel ModifyStageModel Modifies a stage model.