API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Actiontrail/2020-07-06) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Trail
|
API |
Title |
Description |
| CreateTrail | CreateTrail | ActionTrail records events for each Alibaba Cloud account for the last 90 days by default. To track events that occurred more than 90 days ago, you can create a trail to deliver operation events to Object Storage Service (OSS), Simple Log Service, or MaxCompute for event analysis. |
| DeleteTrail | DeleteTrail | Deletes a trail. |
| StartLogging | StartLogging | Enables a trail to start delivering ActionTrail events to Object Storage Service (OSS), Simple Log Service (SLS), or MaxCompute. |
| UpdateTrail | UpdateTrail | Updates the configurations of a trail. |
| StopLogging | StopLogging | Disables a trail to stop delivering ActionTrail events to Object Storage Service (OSS), Simple Log Service (SLS), or MaxCompute. |
| GetTrailStatus | GetTrailStatus | Queries the status of a trail. |
| DescribeTrails | DescribeTrails | Queries created trails. |
Event
|
API |
Title |
Description |
| LookupEvents | LookupEvents | Retrieves detailed historical events. |
Historical event delivery tasks
|
API |
Title |
Description |
| CreateDeliveryHistoryJob | CreateDeliveryHistoryJob | Creates a data backfill task. |
| DeleteDeliveryHistoryJob | DeleteDeliveryHistoryJob | Deletes a data backfill task. |
| ListDeliveryHistoryJobs | ListDeliveryHistoryJobs | Queries a list of data backfill tasks. |
| GetDeliveryHistoryJob | GetDeliveryHistoryJob | Queries the details of a data backfill task. |
AccessKey pair audit
|
API |
Title |
Description |
| GetAccessKeyLastUsedEvents | GetAccessKeyLastUsedEvents | Queries the information about the most recent events that are generated when a specified AccessKey pair is called to access Alibaba Cloud services. |
| GetAccessKeyLastUsedInfo | GetAccessKeyLastUsedInfo | Queries the information about the most recent call of a specified AccessKey pair. |
| GetAccessKeyLastUsedIps | GetAccessKeyLastUsedIps | Queries the information about the IP addresses that are most recently used when an AccessKey pair is called to access Alibaba Cloud services. |
| GetAccessKeyLastUsedProducts | GetAccessKeyLastUsedProducts | Queries the information about the Alibaba Cloud services that are most recently accessed by using a specified AccessKey pair. |
| GetAccessKeyLastUsedResources | GetAccessKeyLastUsedResources | Queries the information about the resources that are most recently accessed by using a specified AccessKey pair. |
Data event selector
|
API |
Title |
Description |
| DeleteDataEventSelector | DeleteDataEventSelector | Deletes the data event selector for a specified trail. |
Other
|
API |
Title |
Description |
| UpdateAdvancedQueryTemplate | UpdateAdvancedQueryTemplate | Updates an advanced query template. |
| GetGlobalEventsStorageRegion | GetGlobalEventsStorageRegion | Queries the region where global events are stored. |
| UpdateGlobalEventsStorageRegion | UpdateGlobalEventsStorageRegion | Specifies the region where you want to store global events. |
| CreateAdvancedQueryTemplate | CreateAdvancedQueryTemplate | Creates an advanced query template. |
| DeleteAdvancedQueryTemplate | DeleteAdvancedQueryTemplate | Deletes an advanced query template. |
| EnableInsight | EnableInsight | Enables the Insights feature |
| DescribeAdvancedQueryTemplate | DescribeAdvancedQueryTemplate | Queries advanced query templates. |
| DescribeUserAlertCount | DescribeUserAlertCount | Queries the number of daily alerts within a specific time range. |
| DescribeUserLogCount | DescribeUserLogCount | Queries the number of daily logs within a specific time range. |
| GetAdvancedQueryTemplate | GetAdvancedQueryTemplate | Retrieves the details of a single advanced template. |
| DeleteAdvancedQueryHistory | DeleteAdvancedQueryHistory | Deletes a specified advanced query history record. |
| CreateAdvancedQueryHistory | CreateAdvancedQueryHistory | This operation creates an advanced query history record. It lets you save custom conditional statements for reuse and management. |
| DescribeAdvancedQueryHistory | DescribeAdvancedQueryHistory | Retrieves all advanced query history records. |
| DescribeResourceLifeCycleEvents | DescribeResourceLifeCycleEvents | This operation queries the lifecycle events for a specific resource. |
| DescribeScenes | DescribeScenes | This operation queries all advanced query scenarios. |
| DescribeSearchTemplates | DescribeSearchTemplates | Queries the system templates for advanced search based on a specified scenario. |
| ListDataEventServices | ListDataEventServices | Queries the services that support data events and the names of the events. |
| GetGovernanceMetrics | GetGovernanceMetrics | Queries the governance metrics of ActionTrail. |
Others
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the Alibaba Cloud regions that are supported by ActionTrail. |