API Gateway is integrated with ActionTrail. In the ActionTrail console, you can query the management events that are generated when you manage API Gateway resources. ActionTrail can deliver management events to Logstores in Log Service or Object Storage Service (OSS) buckets. This way, you can audit the events in real time and locate the causes of issues.
ActionTrail generates management events when you manage cloud resources by using APIs or the Alibaba Cloud Management Console. The following table describes the management events of API Gateway that you can query in the ActionTrail console.
Event name |
Description |
AbolishApi |
Unpublishes an API. |
AcquireGatewayToken |
Queries the token that can be used to access an API Gateway instance. |
AddAccessControlListEntry |
Adds IP entries to an access control list (ACL). |
AddIpControlPolicyItem |
Adds a policy to an IP address-based access control item. |
AddTrafficSpecialControl |
Adds a special throttling policy. |
ApiDiff |
Compares APIs. |
AttachPlugin |
Binds an API Gateway plug-in to an API. |
BatchAbolishApis |
Unpublishes multiple APIs at a time. |
BatchDeployApis |
Publishes multiple APIs at a time. |
CheckAllowedUser |
Checks whether a user is in a user whitelist. |
CheckFcServiceLinkedRole |
Checks the service-linked role of Function Compute. |
CheckInstanceSupportStageName |
Checks the names of the stages that are supported by an API Gateway instance. |
Create |
Purchases an API Gateway instance on the buy page. |
CreateAccessControlList |
Creates an ACL. |
CreateApi |
Creates an API. |
CreateApiGroup |
Creates an API group. |
CreateApiStageVariable |
Creates an environment variable. |
CreateApp |
Creates an application. |
CreateAppForBackend |
Creates an application. |
CreateBackend |
Creates a backend service. |
CreateBackendModel |
Creates a backend model. |
CreateCustomizedInfo |
Creates custom information about an API. |
CreateCustomizedInfoForConsole |
Creates custom information about an API. |
CreateFcServiceLinkedRole |
Creates the service-linked role for Function Compute. |
CreateGroupConfigSynFlow |
Creates a task to import an API group. |
CreateInstance |
Creates an API Gateway instance. |
CreateIntranetDomain |
Creates an internal domain. |
CreateIpControl |
Creates an IP address-based access control item. |
CreateLogConfig |
Creates a log configuration. |
CreateModel |
Creates a model. |
CreateMonitorGroup |
Enables CloudMonitor alerting for an API group. |
CreatePlugin |
Creates an API Gateway plug-in. |
CreateSecretKey |
Creates a key. |
CreateSignature |
Creates a signature key. |
CreateTrafficControl |
Creates a custom throttling policy. |
CreateUserWhiteList |
Creates a user whitelist. |
DeleteAccessControlList |
Deletes an ACL. |
DeleteAllTrafficSpecialControl |
Deletes all special throttling policies. |
DeleteApi |
Deletes an API. |
DeleteApiGroup |
Deletes an API group. |
DeleteApiStageVariable |
Deletes a specified environment variable. |
DeleteApp |
Deletes a specified application. |
DeleteBackend |
Deletes a backend service. |
DeleteBackendModel |
Deletes a backend model. |
DeleteDomain |
Deletes a domain name. |
DeleteDomainCertificate |
Deletes an SSL certificate of a specified domain name. |
DeleteInstance |
Deletes an API Gateway instance. |
DeleteIpControl |
Deletes an IP address-based access control item. |
DeleteLogConfig |
Deletes a log configuration. |
DeleteModel |
Deletes an existing model. |
DeleteMonitorGroup |
Disables CloudMonitor alerting for an API group. |
DeletePlugin |
Deletes an API Gateway plug-in. |
DeleteProduct |
Deactivates API Gateway. |
DeleteSignature |
Deletes a backend signature key. |
DeleteTrafficControl |
Deletes a custom throttling policy. |
DeleteTrafficSpecialControl |
Deletes a special throttling policy. |
DeleteUserWhiteListByType |
Removes a user from a user whitelist. |
DeployApi |
Publishes an API to a specified environment. |
DescribeAbolishApiTask |
Queries the progress of an API unpublishing task. |
DescribeAccessControlListAttribute |
Queries the details of an ACL. |
DescribeAccessControlLists |
Queries ACLs. |
DescribeAccordanceApis |
Queries the APIs that have the same definition in precheck results. |
DescribeApi |
Queries the definition of an API. |
DescribeApiDoc |
Queries the documentation of an API. |
DescribeApiDocForConsole |
Queries the documentation of an API. |
DescribeApiDocs |
Queries the documentations of APIs. |
DescribeApiError |
Queries the error data of an API. |
DescribeApiErrorData |
Queries the error data of an API. |
DescribeApiForConsole |
Queries the definition of an API. |
DescribeApiGroup |
Queries the details of an API group. |
DescribeApiGroupDetail |
Queries the details of an API group. |
DescribeApiGroupDetailForConsumer |
Queries the details of an API group. |
DescribeApiGroupDetailForConsumerForConsole |
Queries the details of an API group. |
DescribeApiGroups |
Queries API groups. |
DescribeApiGroupVpcWhitelist |
Queries the virtual private cloud (VPC) whitelist of an API group. |
DescribeApiHistories |
Queries the historical versions of a specified API. |
DescribeApiHistory |
Queries the definition of an API of a specified historical version. |
DescribeApiIpControls |
Queries the IP address-based access control items that are bound to APIs. |
DescribeApiLatency |
Queries the latency data of an API. |
DescribeApiLatencyData |
Queries the statistics about the latency data of a specified API. |
DescribeApiMarketAttributes |
Queries the attributes of an API. |
DescribeApiMarketInstance |
Queries the APIs that are available on Alibaba Cloud Marketplace. |
DescribeApiQps |
Queries the queries per second (QPS) of a specified API. |
DescribeApiQpsData |
Queries the QPS statistics of a specified API. |
DescribeApiRules |
Queries API rules. |
DescribeApiRulesForConsole |
Queries API rules. |
DescribeApis |
Queries APIs. |
DescribeApisByApp |
Queries the APIs that are bound to an application. |
DescribeApisByBackend |
Queries the APIs that are bound to a backend service. |
DescribeApisByIpControl |
Queries the APIs that are bound to an IP address-based access control item. |
DescribeApisByRule |
Queries the APIs that are bound to an API rule. |
DescribeApisByRuleForConsole |
Queries the APIs that are bound to an API rule. |
DescribeApisBySignature |
Queries the APIs that are bound to a specified signature key. |
DescribeApisByTrafficControl |
Queries the APIs that are bound to a specified throttling policy. |
DescribeApisByVpcAccess |
Queries the APIs that are bound to a VPC authorization. |
DescribeApisForConsole |
Queries APIs. |
DescribeApiSignatures |
Queries the signature keys that are bound to APIs. |
DescribeApiStage |
Queries an API stage. |
DescribeApiStageDetail |
Queries the details of an API stage. |
DescribeApiTraffic |
Queries the traffic data of an API. |
DescribeApiTrafficControls |
Queries the throttling policies that are bound to APIs. |
DescribeApiTrafficData |
Queries the traffic data of an API. |
DescribeApp |
Queries the applications that can be authorized to call APIs. |
DescribeAppAttributes |
Queries applications and the basic information about the applications. |
DescribeApps |
Queries applications. |
DescribeAppsByApi |
Queries applications based on APIs. |
DescribeAppSecurities |
Queries the key of a specified application. |
DescribeAppSecuritiesForConsole |
Queries the key of an application. |
DescribeAppSecurity |
Queries the key of a specified application. |
DescribeAppSecurityForConsole |
Queries the key of an application. |
DescribeAppsForProvider |
Queries the applications of providers. |
DescribeAuthorizedApis |
Queries the APIs that an application is authorized to call. |
DescribeAuthorizedApps |
Queries the applications that are authorized to call APIs. |
DescribeBackendDifferentApis |
Queries the APIs that have different backend service definitions. |
DescribeBackendInfo |
Queries the information about a backend service. |
DescribeBackendList |
Queries backend services. |
DescribeConflictApis |
Queries the APIs that have different definitions. |
DescribeDeployApiTask |
Queries the progress of an API publishing task. |
DescribeDeployedApi |
Queries the definition of an API in a specified environment. |
DescribeDeployedApis |
Queries the APIs that are running in a specified environment. |
DescribeDomain |
Queries the details of a custom domain name. |
DescribeDomainsResolution |
Queries available domain names. |
DescribeGroupConfigSynFlow |
Queries the information about a task to import an API group. |
DescribeGroupConfigSynFlows |
Queries the tasks to import an API group. |
DescribeGroupHttpCode |
Queries the HTTP status code of an API group. |
DescribeGroupLatency |
Queries the latency data of an API group. |
DescribeGroupQps |
Queries the QPS data of an API group. |
DescribeGroupTraffic |
Queries the traffic data of an API group. |
DescribeHistoryApi |
Queries the historical versions of an API. |
DescribeHistoryApiForConsole |
Queries the historical versions of an API. |
DescribeHistoryApis |
Queries the historical versions of APIs. |
DescribeInstanceDropConnections |
Queries the dropped connections of an API Gateway instance. |
DescribeInstanceDropPacket |
Queries the number of data packets that are discarded by an API Gateway instance. |
DescribeInstanceHttpCode |
Queries the HTTP status code of an API Gateway instance. |
DescribeInstanceLatency |
Queries the latency data of an API Gateway instance. |
DescribeInstanceNewConnections |
Queries the number of new connections of an API Gateway instance. |
DescribeInstancePackets |
Queries the number of data packets of an API Gateway instance. |
DescribeInstanceQps |
Queries the QPS data of an API Gateway instance. |
DescribeInstances |
Queries API Gateway instances. |
DescribeInstanceSlbConnect |
Queries the information about the Server Load Balancer (SLB) instance that is connected to an API Gateway instance. |
DescribeInstanceTraffic |
Queries the traffic data of an API Gateway instance. |
DescribeIpControlPolicyItems |
Queries the policies of an IP address-based access control item. |
DescribeIpControls |
Queries IP address-based access control items. |
DescribeLogConfig |
Queries log configurations. |
DescribeMarketRemainsQuota |
Queries the remaining quota. |
DescribeModels |
Queries created models. |
DescribePluginApis |
Queries the APIs to which an API Gateway plug-in is bound. |
DescribePlugins |
Queries API Gateway plug-ins and the details of the plug-ins. |
DescribePluginsByApi |
Queries the API Gateway plug-ins that are bound to an API. |
DescribePluginSchemas |
Queries the plug-in modes that are supported by API Gateway. |
DescribePluginTemplates |
Queries the templates of an API Gateway plug-in. |
DescribeProduct |
Queries the details of API Gateway. |
DescribePurchasedApiGroup |
Queries the details of an API group that is purchased. |
DescribePurchasedApiGroupDetail |
Queries the details of an API group that is purchased. |
DescribePurchasedApiGroups |
Queries the API groups that are purchased. |
DescribePurchasedApis |
Queries the API groups that are purchased. |
DescribeReadyNewApis |
Queries the new APIs that are discovered after a precheck. |
DescribeReadyReservationApis |
Queries the missing APIs that are discovered after a precheck. |
DescribeRegionHttpCode |
Queries the HTTP status code data of a region. |
DescribeRegionLatency |
Queries the latency data of a region. |
DescribeRegionQps |
Queries the QPS data of a region. |
DescribeRegionQpsGroupByInstance |
Queries QPS groups in a region by API Gateway instance. |
DescribeRegions |
Queries the regions that are supported by API Gateway. |
DescribeRegionTraffic |
Queries the traffic data of a region. |
DescribeRulesByApi |
Queries rules by API. |
DescribeSecretKeys |
Queries keys. |
DescribeSignatures |
Queries backend signature keys. |
DescribeSignaturesByApi |
Queries the backend signature keys that are bound to an API. |
DescribeSubscribe |
Queries the subscription information. |
DescribeSummaryData |
Queries the summary information. |
DescribeSyncApiTask |
Queries the details of a synchronization task in which API data is successfully synchronized between API groups. |
DescribeSyncFailApiTask |
Queries the details of a synchronization task in which API data fails to be synchronized between API groups. |
DescribeSystemParameters |
Queries system parameters. |
DescribeTagKeys |
Queries tag keys. |
DescribeTags |
Queries tags. |
DescribeTrafficControls |
Queries throttling policies and the details of the policies. |
DescribeTrafficControlsByApi |
Queries the throttling policies that are bound to an API. |
DescribeUpdateBackendTask |
Queries the results of an update task for a backend service. |
DescribeUpdateVpcInfoTask |
Queries the update status of the APIs that are bound to a VPC authorization. |
DescribeUserWhiteLists |
Queries user whitelists. |
DescribeVarDiffBetweenGroup |
Queries the variable differences between API groups. |
DescribeVpcAccesses |
Queries the VPCs that API Gateway is authorized to access. |
DescribeWillBeSyncApis |
Queries the APIs to be synchronized. |
DescribeZones |
Queries available zones in a region. |
DetachPlugin |
Unbinds an API Gateway plug-in from an API. |
DisableInstanceAccessControl |
Disables an ACL for an API Gateway instance. |
DryRunSwagger |
Checks the syntax before Swagger-compliant data is imported. |
EnableInstanceAccessControl |
Enables an ACL for an API Gateway instance. |
ExportSwagger |
Exports Swagger-compliant data. |
ExportSwaggerForConsole |
Exports Swagger-compliant data. |
GetApiMethods |
Queries API call methods. |
GetApiMethodsForConsole |
Queries the call methods of an API. |
GetCustomizedInfo |
Queries the custom information about an API. |
GetCustomizedInfoForConsole |
Queries the custom information about an API. |
ImportSwagger |
Creates an API by importing Swagger-compliant data. |
IsIncludedByUserWhitelist |
Queries whether a user is in a user whitelist. |
ListTagResources |
Queries the tags that are added to resources. |
Modify |
Modifies the specifications of an API Gateway instance on the buy page. |
ModifyApi |
Modifies the definition of an API. |
ModifyApiConfiguration |
Modifies the definition of an API. |
ModifyApiGroup |
Modifies the name or description of an API group. |
ModifyApiGroupInstance |
Changes the API Gateway instance to which an API group belongs. |
ModifyApiGroupNetworkPolicy |
Modifies the network policy of an API group. |
ModifyApiGroupVpcWhitelist |
Modifies the VPC whitelist of an API group. |
ModifyApiMarketAttributes |
Modifies the attributes of an API that is available on Alibaba Cloud Marketplace. |
ModifyApiMarketInstanceAttribute |
Modifies the attributes of an API that is available on Alibaba Cloud Marketplace. |
ModifyApp |
Modifies the basic information about an application. |
ModifyBackend |
Modifies the basic information about a backend service. |
ModifyBackendModel |
Modifies a backend model. |
ModifyGroupAuthAppCodeForBackend |
Changes the application that is used by a backend service for group authentication. |
ModifyInstanceAttribute |
Modifies the attributes of a specified API Gateway instance. |
ModifyInstanceAttributeForConsole |
Modifies the attributes of a specified API Gateway instance. |
ModifyInstanceSpec |
Modifies the specifications of an API Gateway instance. |
ModifyInstanceVpcAttribute |
Changes the VPC to which an Elastic Compute Service (ECS) instance is connected. |
ModifyInstanceVpcAttributeForConsole |
Modifies the VPC to which an ECS instance is connected. |
ModifyIpControl |
Modifies the information about an IP address-based access control item. |
ModifyIpControlPolicyItem |
Modifies the information about a policy in an IP address-based access control item. |
ModifyLogConfig |
Modifies the information about a log configuration. |
ModifyModel |
Modifies the information about a model. |
ModifyPlugin |
Modifies the information about an API Gateway plug-in. |
ModifySignature |
Modifies the information about a backend signature key. |
ModifyTrafficControl |
Modifies the information about a custom throttling policy. |
ModifyVpcAccessAndUpdateApis |
Modifies the information about a VPC authorization, such as the VpcId, InstanceId, and Port parameters, and the metadata of the APIs that are bound to the VPC authorization. |
OpenApiGatewayService |
Activates API Gateway. |
OpenService |
Activates API Gateway. |
PublishProduct |
Publishes a product. |
QueryRequestLogs |
Queries request logs. |
ReactivateDomain |
Reactivates a custom domain name whose validity status is Abnormal. |
RecoverApiFromHistorical |
Restores an API to a historical version. |
RecoverApiFromHistoricalForConsole |
Restores an API to a historical version. |
RefreshMarketGroupAuthorizations |
Modifies the authorization configurations of groups of APIs available on Alibaba Cloud Marketplace. |
RefundInstance |
Unsubscribes from an instance. |
Release |
Releases a resource such as an instance. |
RemoveAccessControlListEntry |
Removes IP entries from an ACL. |
RemoveAccessPermissionByApps |
Revokes access permissions by application. |
RemoveApiRule |
Deletes an API rule. |
RemoveApiRuleForConsole |
Deletes an API rule. |
RemoveApisAuthorities |
Revokes the access permissions of an application on multiple APIs. |
RemoveAppsAuthorities |
Revokes the access permissions of multiple applications on a specified API. |
RemoveIpControlApis |
Unbinds APIs from an IP address-based access control item. |
RemoveIpControlPolicyItem |
Removes one or more policies from an IP address-based access control item. |
RemoveSignatureApis |
Unbinds a backend signature key from APIs. |
RemoveTrafficControlApis |
Unbinds a specified throttling policy from APIs. |
RemoveVpcAccess |
Deletes a VPC authorization. |
RemoveVpcAccessAndAbolishApis |
Deletes a VPC authorization and unpublishes the APIs that are bound to the VPC authorization. |
Renew |
Renews a resource such as an instance or a resource plan. |
ResetAppCode |
Resets the code of an application. |
ResetAppKeySecret |
Resets the key of an application. |
ResetAppSecret |
Resets the key of an application. |
ResetCustomizedForConsole |
Resets the custom information about an API. |
SdkGenerateByApp |
Generates an SDK by application. |
SdkGenerateByAppForRegion |
Generates an SDK by application. |
SdkGenerateByGroup |
Generates an SDK by API group. |
SetAccessPermissionByApis |
Configures access permissions by API. |
SetAccessPermissionByGroupForBackend |
Configures access permissions for a backend service. |
SetApiRule |
Configures an API rule. |
SetApiRuleForConsole |
Configures an API rule. |
SetApisAuthorities |
Grants access permissions on multiple APIs to a specified application. |
SetAppsAuthorities |
Grants access permissions on an API to multiple applications. |
SetDomain |
Binds a custom domain name to a specified API group. |
SetDomainCertificate |
Uploads an SSL certificate for a specified custom domain name. |
SetDomainWebSocketStatus |
Configures the WebSocket status of a domain name. |
SetGroupAuthAppCode |
Configures whether an API group supports applications. |
SetGroupConfigSynchronizePolicy |
Configures a synchronization policy for a specified API group. |
SetIpControlApis |
Binds APIs to a specified IP address-based access control item. |
SetPurchasedApiGroupStatus |
Configures the status of an API group that is purchased. |
SetSignatureApis |
Binds APIs to a specified signature key. |
SetTrafficControlApis |
Binds APIs to a specified throttling policy. |
SetVpcAccess |
Creates a VPC authorization. |
SetWildcardDomainPatterns |
Configures a wildcard domain name template. |
SwitchApi |
Switches the definition of a running API in a specified environment. |
SwitchInstanceFlow |
Switches instance traffic. |
SynchronizeGroupConfigFlowStart |
Starts the synchronization of API data between API groups. |
TagResources |
Adds tags to resources. |
TagResourcesSystemTags |
Adds system tags to resources. |
UntagResources |
Removes tags from resources. |
VpcGrantAccess |
Creates a VPC authorization. |
VpcModifyAccessForConsole |
Modifies the name of a VPC authorization. |
VpcRevokeAccess |
Deletes a VPC authorization. |