All Products
Search
Document Center

API Gateway:List of operations by function

Last Updated:Jul 31, 2025
This product(CloudAPI/2016-07-14) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Intranet domain name resolution

APITitleDescription
DissociateInstanceWithPrivateDNSDissociateInstanceWithPrivateDNSDisassociates an internal domain name resolution from a dedicated instance.
DeletePrivateDNSDeletePrivateDNSDeletes an internal domain name resolution.
AssociateInstanceWithPrivateDNSAssociateInstanceWithPrivateDNSAssociates an internal domain name resolution with a dedicated instance.
CreatePrivateDNSCreatePrivateDNSCreates an internal domain name resolution and adds a resolution record.
ListPrivateDNSListPrivateDNSQueries internal domain name resolutions by domain name or resolution type.
UpdatePrivateDNSUpdatePrivateDNSModifies an internal domain name resolution.

Instances

APITitleDescription
ModifyInstanceVpcAttributeForConsoleModify instance client VPC configModify instance client VPC config.
CreateInstanceCreateInstanceCreates an API Gateway instance.
DeleteInstanceDeleteInstanceDeletes an API Gateway instance.
ModifyInstanceAttributeModifyInstanceAttributeModifies the properties of an API Gateway instance.
ModifyInstanceSpecModifyInstanceSpecUpgrades or downgrades the configurations of an API Gateway instance.
EnableInstanceAccessControlEnableInstanceAccessControlThis feature provides instance-level access control capabilities for dedicated API Gateway instances. Specifies the access control policy of an instance.
DisableInstanceAccessControlDisableInstanceAccessControlThis feature provides instance-level access control capabilities for dedicated API Gateway instances. Disables access control on an instance.
DescribeInstancesDescribeInstancesQueries the details of instances in a region. The instances include shared instances and dedicated instances.

API groups

APITitleDescription
ModifyIntranetDomainPolicyModifyIntranetDomainPolicyModifies the VPC domain name policy of an API group.
CreateApiGroupCreateApiGroupCreates an API group.
DeleteApiGroupDeleteApiGroupDeletes an API group.
ModifyApiGroupModifyApiGroupModifies the name, description, or basepath of an existing API group.
DescribeApiGroupDescribeApiGroupYou can call this operation to query details about an API group, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.
DescribeApiGroupsDescribeApiGroupsQueries existing API groups and their basic information.
DescribePurchasedApiGroupDescribePurchasedApiGroupQueries the details about an API group purchased from Alibaba Cloud Marketplace.
DescribePurchasedApiGroupsDescribePurchasedApiGroupsQueries the API groups purchased from Alibaba Cloud Marketplace.

Domains

APITitleDescription
DeleteDomainDeleteDomainUnbinds a custom domain name from an API group.
DeleteDomainCertificateDeleteDomainCertificateDeletes 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.
SetDomainSetDomainBinds a custom domain name to a specified API group.
SetDomainCertificateSetDomainCertificateUploads an SSL certificate for a specified custom domain name.
SetDomainWebSocketStatusSetDomainWebSocketStatusEnables or disables WebSocket for a custom domain name.
SetWildcardDomainPatternsSetWildcardDomainPatternsSpecifies a wildcard domain name template for a bound custom domain name.
DescribeDomainDescribeDomainQueries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.
ReactivateDomainReactivateDomainReactivates a custom domain name whose validity status is Abnormal.

Monitor

APITitleDescription
CreateMonitorGroupCreateMonitorGroupEnables CloudMonitor alerting for a specified API group.
DeleteMonitorGroupDeleteMonitorGroupDeletes a CloudMonitor application group corresponding to an API group.
DescribeApiLatencyDataDescribeApiLatencyDataQueries the response time statistics of an API.
DescribeApiQpsDataDescribeApiQpsDataQueries the QPS statistics of an API.
DescribeApiTrafficControlsDescribeApiTrafficControlsQueries the throttling policies bound to all members of an API group in a specified environment.
DescribeApiTrafficDataDescribeApiTrafficDataQueries the statistics on the traffic of an API.
DescribeInstanceDropPacketDescribeInstanceDropPacketQueries the number of dropped packets within a period of time.
DescribeInstanceDropConnectionsDescribeInstanceDropConnectionsQueries the number of lost connections to a dedicated instance within a period of time.
DescribeInstanceHttpCodeDescribeInstanceHttpCodeQueries the distribution of HTTP status codes of requests to a dedicated instance within a period of time.
DescribeInstanceLatencyDescribeInstanceLatencyQueries the average latency of a dedicated instance over a period of time.
DescribeInstanceNewConnectionsDescribeInstanceNewConnectionsQueries the number of new connections to a dedicated instance within a period of time.
DescribeInstancePacketsDescribeInstancePacketsQueries the numbers of inbound and outbound packets of a dedicated instance within a period of time.
DescribeInstanceQpsDescribeInstanceQpsQueries the number of requests to a dedicated instance within a period of time.
DescribeInstanceSlbConnectDescribeInstanceSlbConnectQueries the number of concurrent connections to a dedicated instance within a period of time.
DescribeInstanceTrafficDescribeInstanceTrafficQueries the request traffic and response traffic of a dedicated instance within a period of time.
DescribeGroupQpsDescribeGroupQpsQueries the statistics on the number of requests directed to an API group within a period of time.

API management

APITitleDescription
CreateApiCreateApiCreates an API.
CreateApiStageVariableCreateApiStageVariableAdds a variable to an environment.
ImportOASImportOASImports OpenAPI Specification (OAS)-compliant data to create an API.
ImportSwaggerImportSwaggerCreates an API by importing Swagger-compliant data.
DeleteApiDeleteApiDeletes the definition of a specified API.
DeleteApiStageVariableDeleteApiStageVariableDeletes a specified variable in a specified environment.
ModifyApiConfigurationModifyApiConfigurationThis 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.
ModifyApiModifyApiModifies the definition of an API.
DescribeApisByBackendDescribeApisByBackendQueries APIs in the draft or published state that are created by using a specified backend service.
DescribeApiDescribeApiQueries the definition of an API.
DescribeApiMarketAttributesDescribeApiMarketAttributesQueries the Alibaba Cloud Marketplace attributes of an API.
DescribeApisDescribeApisQueries a list of APIs that are being defined.
DescribeApiHistoryDescribeApiHistoryQueries the details of a specified historical version of a specified API definition.
DescribeApisByAppDescribeApisByAppQueries the APIs with which an application is associated.
DescribeAuthorizedApisDescribeAuthorizedApisQueries the authorized APIs of a specified APP.
DescribeApiDocDescribeApiDocQueries the documentation of an API.
DescribeDeployedApiDescribeDeployedApiQueries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited.
DescribeHistoryApisDescribeHistoryApisQueries the historical versions of an API.
DescribeImportOASTaskDescribeImportOASTaskQueries the result of an OAS API import task.
DescribePurchasedApisDescribePurchasedApisQueries the APIs purchased in the Alibaba Cloud Marketplace.
DescribeApiHistoriesDescribeApiHistoriesQueries the historical versions of a specified API.
DescribeDeployedApisDescribeDeployedApisQueries the APIs that have been published to a specified environment.
DescribeMarketRemainsQuotaDescribeMarketRemainsQuotaQueries the number of remaining ordered relationships for a purchaser.
DescribeDeployApiTaskDescribeDeployApiTaskQueries the progress of an asynchronous API publishing task.
DescribeAbolishApiTaskDescribeAbolishApiTaskQueries the progress of an API unpublishing task.
AbolishApiAbolishApiUnpublishes a specified API from a specified runtime environment.
DeployApiDeployApiPublishes an API to a specified environment.
BatchDeployApisBatchDeployApisPublishes multiple APIs at a time.
BatchAbolishApisBatchAbolishApisUnpublishes multiple published APIs at a time.
SwitchApiSwitchApiSwitches the definition of an API in a specified runtime environment to a historical version.
DryRunSwaggerDryRunSwaggerChecks the syntax before Swagger-compliant data is imported.

Applications

APITitleDescription
CreateAppCreateAppCreates an app for API Gateway.
DeleteAppDeleteAppDeletes a specified app.
ModifyAppModifyAppModifies a specified app.
DescribeAppsDescribeAppsQueries the apps of a user. App information is returned only to the app owner.
DescribeAppAttributesDescribeAppAttributesQueries apps and their basic information.
DescribeAuthorizedAppsDescribeAuthorizedAppsQueries the current apps.
DescribeAppDescribeAppQueries the apps that can be authorized.
DescribeAppSecurityDescribeAppSecurityThis key is used for authentication when an API call is made.
ResetAppCodeResetAppCodeResets the AppCode of an application. You can call this operation only once per minute.

VPC

APITitleDescription
RemoveVpcAccessRemoveVpcAccessDeletes a VPC access authorization without unpublishing the associated APIs.
RemoveVpcAccessAndAbolishApisRemoveVpcAccessAndAbolishApisDeletes a VPC access authorization and unpublishes the associated API.
ModifyVpcAccessAndUpdateApisModifyVpcAccessAndUpdateApisModifies the information of a VPC access authorization and updates the metadata of the associated API.
ModifyApiGroupVpcWhitelistModifyApiGroupVpcWhitelistModifies the VPC whitelist of an API group.
SetVpcAccessSetVpcAccessCreates a virtual private cloud (VPC) access authorization and enables reverse access.
DescribeApiGroupVpcWhitelistDescribeApiGroupVpcWhitelistQueries the VPC whitelist that is allowed to access an API group.
DescribeVpcAccessesDescribeVpcAccessesQueries VPC access authorizations.
DescribeUpdateVpcInfoTaskDescribeUpdateVpcInfoTaskQueries the update progress of an API that is being published after its associated VPC access authorization is updated.
ValidateVpcConnectivityValidateVpcConnectivityTests 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

APITitleDescription
CreateAccessControlListCreateAccessControlListThis 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.
DeleteAccessControlListDeleteAccessControlListThis feature provides instance-level access control capabilities for dedicated instances. Deletes an access control policy.
SetAccessControlListAttributeSetAccessControlListAttributeThis feature provides instance-level access control for dedicated instances. Modifies the name of an access control policy.
AddAccessControlListEntryAddAccessControlListEntryThis feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance.
RemoveAccessControlListEntryRemoveAccessControlListEntryThis feature provides instance-level access control for dedicated instances. Deletes an IP address entry from an access control policy.
DescribeAccessControlListAttributeDescribeAccessControlListAttributeThis feature provides instance-level access control for dedicated instances. Queries the details of an access control policy.
DescribeAccessControlListsDescribeAccessControlListsThis feature provides instance-level access control for dedicated instances. Queries access control policies.

Plugins

APITitleDescription
DetachGroupPluginUnbind the plugin from the groupUnbind group plugin
AttachGroupPluginAttach plugin to groupAttach plugin to API group.
DescribePluginsByGroupQuery Plugins Bound to API GroupQuery Plugins Bound to API Group
DescribePluginGroupsQuery the List of Groups Bound to a PluginQuery the list of groups bound to a plugin based on the plugin ID
CreatePluginCreatePluginCreates a plug-in.
DeletePluginDeletePluginDeletes a plug-in.
AttachPluginAttachPluginBinds a plug-in to an API.
ModifyPluginModifyPluginModifies the information of a plug-in.
DetachPluginDetachPluginUnbinds a plug-in from an API.
DescribePluginApisDescribePluginApisQueries the APIs to which a specified plug-in is bound.
DescribePluginsByApiDescribePluginsByApiQueries the plug-ins that are bound to a running API in a specified environment.
DescribePluginSchemasDescribePluginSchemasDescribes the plug-in modes supported by API Gateway.
DescribePluginTemplatesDescribePluginTemplates
DescribePluginsDescribePluginsQueries API Gateway plug-ins and the details of the plug-ins.

Custom datasets

APITitleDescription
CreateDatasetCreateDatasetCreates a custom dataset.
CreateDatasetItemCreateDatasetItemCreates a data entry in a custom dataset.
DeleteDatasetDeleteDatasetDeletes a custom dataset.
DeleteDatasetItemDeleteDatasetItemDeletes a data entry from a custom dataset.
ModifyDatasetModifyDatasetModifies the name of a custom dataset.
ModifyDatasetItemModifyDatasetItemModifies the timeout period and description of a data entry in a custom dataset.
DescribeDatasetInfoDescribeDatasetInfoQueries the information about a single dataset.
DescribeDatasetListDescribeDatasetListQueries custom datasets.
DescribeDatasetItemInfoDescribeDatasetItemInfoQueries a data entry in a custom dataset.
DescribeDatasetItemListDescribeDatasetItemListQueries the data entries of a custom dataset.

Models

APITitleDescription
CreateModelCreateModelCreates a model for an API group.
DeleteModelDeleteModelDeletes a model.
ModifyModelModifyModelUpdates the model of an API group.
DescribeModelsDescribeModelsQueries the created models of an API group.

Authorization

APITitleDescription
SetApisAuthoritiesSetApisAuthoritiesAuthorizes a specified application to call multiple APIs.
SetAppsAuthoritiesSetAppsAuthoritiesGrants access permissions on a specified API to multiple applications.
RemoveApisAuthoritiesRemoveApisAuthoritiesRevokes the access permissions on multiple APIs from a specified application.
RemoveAppsAuthoritiesRemoveAppsAuthoritiesRevokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API.
ResetAppSecretResetAppSecretResets the key for an app.

Tags

APITitleDescription
ListTagResourcesListTagResourcesQueries the visible resource tags.
TagResourcesTagResourcesAdds user tags to resources.
UntagResourcesUntagResourcesRemoves tags from resources.

Service

APITitleDescription
DescribeSummaryDataDescribeSummaryDataQueries the number of API Gateway resources in a region.
DescribeRegionsDescribeRegionsQueries the Alibaba Cloud regions that are supported by API Gateway.
DescribeSystemParametersDescribeSystemParametersQueries the common parameters supported by the system.
DescribeZonesDescribeZonesQueries zones in a region.
OpenApiGatewayServiceOpenApiGatewayServiceActivates the API Gateway service.

Logs

APITitleDescription
CreateLogConfigCreateLogConfigCreates a Simple Log Service configuration for an API.
DeleteLogConfigDeleteLogConfigDeletes a log configuration.
ModifyLogConfigModifyLogConfig
QueryRequestLogsQueryRequestLogsQueries the request logs of a user.
DescribeLogConfigDescribeLogConfig

SDK

APITitleDescription
SdkGenerateByAppForRegionSdkGenerateByAppForRegion
SdkGenerateByAppSdkGenerateByAppGenerates an SDK by application.
SdkGenerateByGroupSdkGenerateByGroupGenerates an SDK by API group.

Backends

APITitleDescription
CreateBackendCreateBackendCreates a backend service in API Gateway.
DeleteBackendDeleteBackendDeletes a backend service.
ModifyBackendModifyBackendModifies the basic information of a backend service, such as name and description. The backend service type cannot be modified once the backend service is created.
DescribeBackendListDescribeBackendListQueries backend services. You can filter backend services by backend service name and backend service type.
DescribeBackendInfoDescribeBackendInfoQueries the information about a backend service and its URL configured for each environment.
DescribeUpdateBackendTaskDescribeUpdateBackendTaskQueries the update results of associated published APIs after the definition of a backend service is modified in an environment.

Backend models

APITitleDescription
CreateBackendModelCreateBackendModelCreates a backend service configuration in an environment.
DeleteBackendModelDeleteBackendModelDeletes 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.
ModifyBackendModelModifyBackendModelModifies the definition of a backend service in the environment. After the modification, the backend paths of the APIs that use the backend service in the same environment will be updated at the same time automatically. You do not need to manually publish the APIs again.

Signature plugin(Classic network instances)

APITitleDescription
CreateSignatureCreateSignatureCreates a backend signature key.
DeleteSignatureDeleteSignatureDeletes a backend signature key.
ModifySignatureModifySignatureModifies a backend signature key.
SetSignatureApisSetSignatureApisBinds a signature key to APIs.
DescribeSignaturesDescribeSignaturesQueries backend signature keys.
DescribeApisBySignatureDescribeApisBySignatureQueries the APIs to which a specified backend signature key is bound.
DescribeApiSignaturesDescribeApiSignaturesQueries the backend signature keys that are bound to the APIs of a specified API group in a specified environment.
DescribeSignaturesByApiDescribeSignaturesByApiQueries the backend signature keys that are bound to a specified API.
RemoveSignatureApisRemoveSignatureApisUnbinds a backend signature key from APIs.

Traffic control plugin(Classic network instances)

APITitleDescription
AddTrafficSpecialControlAddTrafficSpecialControlAdds a custom special policy to a specified throttling policy.
CreateTrafficControlCreateTrafficControlCreates a custom throttling policy.
DeleteAllTrafficSpecialControlDeleteAllTrafficSpecialControlDeletes all custom special policies of a specified throttling policy.
DeleteTrafficControlDeleteTrafficControlDeletes a custom throttling policy and the special throttling rules in the policy.
DeleteTrafficSpecialControlDeleteTrafficSpecialControlDeletes a custom special throttling policy.
ModifyTrafficControlModifyTrafficControlModifies the settings of a custom throttling policy.
SetTrafficControlApisSetTrafficControlApisBinds a throttling policy to APIs.
DescribeTrafficControlsDescribeTrafficControlsQueries custom throttling policies and their details. Conditional queries are supported.
DescribeTrafficControlsByApiDescribeTrafficControlsByApiQueries the throttling policy that is bound to a specific API.
DescribeApisByTrafficControlDescribeApisByTrafficControlQueries the APIs to which a specified throttling policy is bound.
RemoveTrafficControlApisRemoveTrafficControlApisUnbinds a specified throttling policy from APIs.

Access control plugin(Classic network instances)

APITitleDescription
AddIpControlPolicyItemAddIpControlPolicyItemAdds a policy to an existing ACL.
CreateIpControlCreateIpControlCreates an access control list (ACL) in a region.
DeleteIpControlDeleteIpControlDeletes an access control list (ACL).
ModifyIpControlModifyIpControlModifies an access control list (ACL).
ModifyIpControlPolicyItemModifyIpControlPolicyItemModifies a policy in an access control list (ACL).
SetIpControlApisSetIpControlApisCreates a binding relationship between specified access control lists (ACLs) and APIs.
DescribeApiIpControlsDescribeApiIpControlsQueries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment.
DescribeIpControlPolicyItemsDescribeIpControlPolicyItemsQueries the rule entries of an IP address-based traffic control policy.
DescribeIpControlsDescribeIpControlsQueries custom access control lists (ACLs) on separate pages.
DescribeApisByIpControlDescribeApisByIpControlQueries the APIs that are bound to an access control list (ACL).
RemoveIpControlApisRemoveIpControlApisUnbinds an API from an access control list (ACL).
RemoveIpControlPolicyItemRemoveIpControlPolicyItemRemoves one or more policies from an access control list (ACL).

Other

APITitleDescription
DescribeApisWithStageNameIntegratedByAppDescribeApisWithStageNameIntegratedByAppQueries APIs by application and returns the result by environment.
DescribeGroupLatencyDescribeGroupLatencyQueries the average latency of an API group in an environment.
DescribeGroupTrafficDescribeGroupTrafficQueries the traffic of an API group.
ModifyApiGroupInstanceModifyApiGroupInstance
ModifyApiGroupNetworkPolicyModifyApiGroupNetworkPolicyModifies the network policy of an API group.
DetachApiProductDetachApiProductDetaches APIs from an API product.
SetApiProductsAuthoritiesSetApiProductsAuthoritiesGrants permissions on API products to an application.
DescribeApiProductsByAppDescribeApiProductsByAppQueries API products by application.
DescribeApiProductApisDescribeApiProductApisQueries the attached APIs of an API product.
DescribeAppsByApiProductDescribeAppsByApiProductQueries authorized applications by API product.
AttachApiProductAttachApiProductAttaches APIs to an API product. If the API product does not exist, the system automatically creates the API product.
DeleteApiProductDeleteApiProductDeletes 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.
RemoveApiProductsAuthoritiesRemoveApiProductsAuthoritiesRevokes permissions on API products from an application.
SetAppsAuthToApiProductSetAppsAuthToApiProductAuthorizes multiple applications to call APIs in an API product.
DescribeApisByVpcAccessDescribeApisByVpcAccessQueries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region.
DeleteAppCodeDeleteAppCodeDeletes the AppCode of an application.
DeleteAppKeyDeleteAppKeyDeletes the AppKey and AppSecret of an application.
CreateAppCodeCreateAppCodeAdds an AppCode to an application.
CreateAppKeyCreateAppKeyAdds an AppKey and AppSecret pair to an application.
DescribeInstanceClusterInfoDescribeInstanceClusterInfoQueries the information about a dedicated instance cluster.
DescribeInstanceClusterListDescribeInstanceClusterListQueries dedicated instance clusters.
DescribeAppSecuritiesDescribeAppSecuritiesQueries the key-related information of an application.
ExportOASExportOASExports APIs based on OpenAPI Specification (OAS).