Integration Guides › Web Service API Reference Guide › Valid Web API Objects › log Object

log Object

Use this object to view controller system log data of a VDC.

list Method (log Object)

Description

Retrieve contents of controller's system log

Syntax

/api/v2/log/list?vdc=controller-name 

Arguments

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve the contents of controller's system log.

GET http://192.168.123.200/api/v2/log/list?vdc=mygrid 

Sample Output

XML:

<message></message>

JSON:

{
   "message" :""
}

reset Method (log Object)

Description

Clear the contents of controller's system log

Syntax

/api/v2/log/reset?vdc=controller-name 

Arguments

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Clear controller's system log.

GET http://192.168.123.200/api/v2/log/reset?&vdc=mygrid 

Sample Output

XML:

<message></message>

JSON:

{
   "message" :""
}

mark Method (log Object)

Description

Write a user-defined message into controller's system log

Syntax

/api/v2/log/mark?comment="message"&vdc=controller-name 

Arguments

comment

The message to be written into the controller's system log

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Mark controller's system log.

GET http://192.168.123.200/api/v2/log/mark?comment="Mark"&vdc=mygrid 

Sample Output

XML:

<message></message>

JSON:

{
   "message" :""
}