Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Children Display
alltrue
styleh3
pageSuperb Cloud API

GET /virtual_machines/:virtual_machine_id/transactions

Gets a list of a single VS's transactions without log output.

Sections:

Table of Contents
maxLevel4
minLevel2
includeResponse.*|JSON.*|XML.*|Explanation.*

Response Parameters

pid — external process ID

created_at — the time when the record of transaction was made in the database, in the [YYYY][MM][DD]T[hh][mm][ss]Z format

start_after — the time after which the transaction may start, in the [YYYY][MM][DD]T[hh][mm][ss]Z format

finished_at — reserved detail

updated_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

actor — reserved detail

priority — priority of the transaction (reserved detail)

parent_type — type of the transaction target (virtual server, disk or hypervisor)

action — the type of transaction performed

id —transaction ID

user_id —ID of the user who performed the transaction

dependent_transaction_id —ID of the transaction that the current transaction depends on. For independent transactions this remains empty.

allowed_cancel —true if cancellation is allowed. Otherwise false.

parent_id — ID of the target virtual server, disk or hypervisor

started_at —time when the transaction was started in the [YYYY][MM][DD]T[hh][mm][ss]Z format

params —parameters of the transaction

status —status of the transaction (complete, failed, pending, etc)

identifier —identifier of the virtual server

JSON Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/transactions.json

JSON Response

Code Block
themeRDark
 [
    {
        "transaction": {
            "action": "update_firewall",
            "actor": null,
            "allowed_cancel": true,
            "associated_object_id": 511,
            "associated_object_type": "VirtualMachine",
            "created_at": "2015-08-28T19:05:45+00:00",
            "dependent_transaction_id": null,
            "id": 27614,
            "identifier": "c3yif8x6uufo2r",
            "params": {
                "initiator_id": 337
            },
            "parent_id": 513,
            "parent_type": "NetworkInterface",
            "pid": 15889,
            "priority": 10,
            "start_after": "2015-08-28T19:05:45+00:00",
            "started_at": "2015-08-28T19:05:48+00:00",
            "status": "complete",
            "updated_at": "2015-08-28T19:05:48+00:00",
            "user_id": 337
        }
    }
]

XML Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/transactions.xml

XML Response example

Code Block
languagexml
themeRDark
 <?xml version="1.0" encoding="UTF-8"?>
<transactions type="array">
<transaction>
<pid type="integer">2632</pid>
<created_at type="datetime">2011-07-20T08:28:54Z</created_at>
<start_after type="datetime">2011-07-20T08:28:54Z</start_after>
<updated_at type="datetime">2011-07-20T08:28:59Z</updated_at>
<actor nil="true"></actor>
<priority type="integer">10</priority>
<parent_type>VirtualMachine</parent_type>
<action>startup_virtual_machine</action>
<id type="integer">1547</id>
<user_id type="integer">13</user_id>
<dependent_transaction_id nil="true"></dependent_transaction_id>
<allowed_cancel type="boolean">true</allowed_cancel>
<parent_id type="integer">34</parent_id>
<started_at type="datetime">2011-07-20T08:28:56Z</started_at>
<params>
</params>
<status>complete</status>
<identifier>huilp6uzskz8rr</identifier>
</transaction>
...
<transaction></transaction>
...
</transactions>