Getting information about a trail

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using the --folder-name or --folder-id parameter.

1. See the description of the CLI command for viewing information about a trail:

   yc audit-trails trail get --help
   

2. Get a list of trails:

   yc audit-trails trail list
   

   Result:

   +----------------------+--------------+--------+-------------------+
   |          ID          |     NAME     | STATUS |      FILTERS      |
   +----------------------+--------------+--------+-------------------+
   | cnp82sb0phnm******** | trailfromapi | ACTIVE | storage compute   |
   |                      |              |        | management.events |
   | cnp8v52idttr******** | tf-trail     | ACTIVE | storage compute   |
   |                      |              |        | mdb.postgresql    |
   | cnpnkcubr529******** | test-2       | ACTIVE | compute           |
   +----------------------+--------------+--------+-------------------+
   

3. Get detailed information about your trail by specifying its name or ID:

   yc audit-trails trail get <trail_ID>
   

   Result:

   id: cnp82sb0phnm********
   folder_id: b1geoelk7fld********
   created_at: "2025-02-20T07:28:00.815Z"
   updated_at: "2025-02-20T07:28:00.815Z"
   name: trailfromapi
   description: trailfromapi
   destination:
     object_storage:
       bucket_id: rsample-logs-bucket
   service_account_id: ajenfbssm9o5********
   status: ACTIVE
   cloud_id: b1gia87mbaom********
   filtering_policy:
     management_events_filter:
       resource_scopes:
         - id: b1geoelk7fld********
           type: resource-manager.folder
     data_events_filters:
       - service: mdb.postgresql
         excluded_events:
           event_types:
             - yandex.cloud.audit.mdb.postgresql.CreateDatabase
             - yandex.cloud.audit.mdb.postgresql.UpdateDatabase
         resource_scopes:
           - id: b1gia87mbaom********
             type: resource-manager.cloud
           - id: b1geoelk7fld********
             type: resource-manager.folder
       - service: storage
         resource_scopes:
           - id: b1geoelk7fld********
             type: resource-manager.folder
           - id: b1g0g14rq0mv********
             type: resource-manager.folder
       - service: compute
         resource_scopes:
           - id: b1geoelk7fld********
             type: resource-manager.folder
   

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

To get information about a trail using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_audit_trails_trail" "my-trail" {
     trail_id = "<trail_ID>"
   }
   
   output "my-trail-status" {
     value = data.yandex_audit_trails_trail.my-trail.status
   }
   

   Where:

   • data "yandex_audit_trails_trail": Trail description as a data source:
     • resource_id: Resource ID.
   • output "my-trail-status": Output variable that contains information about the current trail status:
     • value: Returned value.

   You can replace status with any other parameter to get the information you need. For more information about the yandex_audit_trails_trail data source parameters, see the relevant provider documentation.

2. Create the resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create all the required resources and display the output variable values in the terminal. To check the results, run this command:

   terraform output
   

   Result:

   my-trail-status = ACTIVE
   

To get detailed information about a trail, use the get REST API method for the Trail resource or the TrailService/Get gRPC API call.