List user actions

Retrieve user action log for one client or a set of projects

GET /cloud/v1/user_actions

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.audit_logs.list()
page = page.results[0]
print(page.id)

200

{
  "count": 1,
  "results": [
    {
      "acknowledged": true,
      "action_data": "{\"name\": \"test_project_a\"}",
      "action_type": "create",
      "api_group": "project",
      "client_id": 10,
      "email": "[e-mail]",
      "id": "123",
      "is_complete": true,
      "issued_by_user_id": 222324,
      "project_id": 1,
      "region_id": 4,
      "resources": [
        {
          "resource_id": "1234",
          "resource_type": "project",
          "resource_body": {
            "key": "value"
          },
          "search_field": "name"
        }
      ],
      "source_user_ip": "1.2.3.4",
      "task_id": "1bdcc138-e716-41ff-ad8d-3477a7ac6d14",
      "timestamp": "2019-11-14T10:30:32+00:00",
      "token_id": 192021,
      "total_price": {
        "currency_code": "USD",
        "price_per_hour": 0.01,
        "price_per_month": 7.2,
        "price_status": "show"
      },
      "user_agent": "Mozilla/5.0",
      "user_id": 789
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

action_type · enum<string>[]

User action type. Several options can be specified.

Available options: activate, attach, change_logging_resources, create, create_access_rule, deactivate, delete, delete_access_rule, delete_metadata, detach, disable_logging, disable_portsecurity, download, enable_logging, enable_portsecurity, failover, get_certificate, get_console, get_kubeconfig, get_logs, put_into_servergroup, reboot, reboot_hard, rebuild, regenerate_credentials, remove_from_servergroup, replace, replace_metadata, resize, resume, retype, revert, scale_down, scale_up, start, stop, suspend, update, update_metadata, upgrade

Example:

["activate", "delete"]

api_group · enum<string>[]

API group that requested action belongs to. Several options can be specified.

Available options: ai_cluster, baremetal, basic_vm, caas_container, caas_key, caas_pull_secret, dbaas_postgres, ddos_profile, faas_function, faas_key, faas_namespace, file_shares, floating_ip, image, inference_at_the_edge, instance, instance_isolation, k8s_cluster, k8s_cluster_template, k8s_pool, laas, laas_topic, lb_health_monitor, lb_l7policy, lb_l7rule, lblistener, lbpool, lbpool_member, lifecycle_policy, lifecycle_policy_volume_member, loadbalancer, network, port, project, quota_limit_request, registry, reservation, reserved_fixed_ip, role, router, rtbh, secret, securitygroup, securitygrouprule, servergroup, shared_flavor, shared_image, shared_network, slurm, snapshot, snapshot_schedule, ssh_key, subnet, user, vip_ip_addresses, volume

Example:

["ai_cluster", "image"]

from_timestamp · string<date-time>

ISO formatted datetime string. Starting timestamp from which user actions are requested

Example:

"2019-11-14T10:30:32Z"

limit · integer · default: 1000

Optional. Limit the number of returned items

Required range: x <= 1000

Example:

1000

offset · integer · default: 0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Example:

0

order_by · enum<string> · default: desc

Sorting by timestamp. Oldest first, or most recent first

Available options: asc, desc

Example:

"asc"

project_id · integer<int64>[]

Project ID. Several options can be specified.

Example:

[1, 2, 3]

region_id · integer<int64>[]

Region ID. Several options can be specified.

Example:

[1, 2, 3]

resource_id · string[]

Resource ID. Several options can be specified.

search_field · string

Extra search field for common object properties such as name, IP address, or other, depending on the resource_type

Example:

"default"

sorting · enum<string> · default: desc · deprecated

(DEPRECATED Use 'order_by' instead) Sorting by timestamp. Oldest first, or most recent first

Available options: asc, desc

Example:

"asc"

source_user_ips · string[]

Originating IP address of the client making the request. Several options can be specified.

Example:

["203.0.113.42", "192.168.1.100"]

to_timestamp · string<date-time>

ISO formatted datetime string. Ending timestamp until which user actions are requested

Example:

"2019-11-14T10:30:32Z"

user_agents · string[]

User-Agent string identifying the client making the request. Several options can be specified.

Example:

["Mozilla/5.0", "MyApp/1.0.0"]

Response

200

application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · UserAction schema · object[] · required

Objects

Show child attributes