VMware Cloud Director API - AuditEvent

VMware Cloud Director API - AuditEvent

AuditEventType

Element:
AuditEvent
Type:
AuditEventType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Audit event
Since:
5.6
Schema:
event.xsd
Media type(s):
application/vnd.vmware.admin.event+json
application/vnd.vmware.admin.event+xml
application/vnd.vmware.vcloud.admin.auditEvent+xml
application/vnd.vmware.vcloud.admin.auditEvent+json
Extends:
EntityType
XML Representation:
<AuditEvent xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" eventType="xs:string" serviceNamespace="xs:string" timeStamp="xs:dateTime"
        success="xs:boolean">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <Org href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Details> xs:string </Details>
</AuditEvent>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.6 The URI of the entity.
type string No always 5.6 The MIME type of the entity.
id string No none 5.6 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 5.6 The name of the entity.
eventType string Yes none 5.6 A string identifying the type of the event.
serviceNamespace string Yes none 5.6 Identifier of the external service that posted the event or 'com.vmware.vcloud' for internal events.
timeStamp dateTime Yes none 5.6 Timestamp of the event.
success boolean Yes none 5.6 True if the event represents a successful operation. False otherwise.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 5.6 Optional description.
Details string No none 5.6 Event properties in JSON format.
Link LinkType No none 5.6 A reference to an entity or operation associated with this object.
Org ReferenceType Yes none 5.6 A reference to the organization to which the event was posted.
Owner ReferenceType No none 5.6 A reference to the owner of the event.
Tasks TasksInProgressType No none 5.6 A list of queued, running, or recently completed tasks associated with this entity.
User ReferenceType Yes none 5.6 A reference to the user for which the event was created.
VCloudExtension VCloudExtensionType No always 5.6 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/event/{id} Returns event with specified ID. 5.6 35.0