Monitor API

/api/juniper/vdirector/monitor/vms/{vi-id}

The following operations are supported on this resource:

GET /api/juniper/vdirector/monitor/vms/{vi-id} (v1)


Access Control

The following capabilities are required to access this API:
"VSMCap"


Example Usage

GET /api/juniper/vdirector/monitor/vms/{vi-id}


Parameters

NameTypeURI TypeDescriptionRequired
vi-idStringPath   Y

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.


Content Types

  • Produces content types:
    application/net.juniper.vdirector.monitor.vminstance+xml;version=1;q=0.01
    application/net.juniper.vdirector.monitor.vminstance+json;version=1;q=0.01


  • Sample Output XML:
    <vminstance href="/api/juniper/vdirector/monitor/vms/{id}" uri="/api/juniper/vdirector/monitor/vms/{vi-id}">
         <cluster-name>String</cluster-name>
         <v-cpus>Integer</v-cpus>
         <dc-name>String</dc-name>
         <cpu-usage>Integer</cpu-usage>
         <ipaddress>String</ipaddress>
         <guest-mem-usage>Integer</guest-mem-usage>
         <id>Integer</id>
         <annotation>String</annotation>
         <vc-hostname>String</vc-hostname>
         <name>String</name>
         <resource-pool-name>String</resource-pool-name>
         <device-id>Integer</device-id>
         <vc-name>String</vc-name>
         <vm-type>String</vm-type>
         <host-mem-usage>Integer</host-mem-usage>
         <alloc-mem>Integer</alloc-mem>
         <hostname>String</hostname>
         <vm-provision-initiator>String</vm-provision-initiator>
         <vi-id>String</vi-id>
         <v-nics>Integer</v-nics>
         <time-modified>java.util.Date</time-modified>
         <vm-status>String</vm-status>
         <vm-host-name>String</vm-host-name>
         <folder-name>String</folder-name>
         <uuid>String</uuid>
         <attributes>
               <attribute>String</attribute>
         </attributes>
         <port-groups>
               <port-group>String</port-group>
         </port-groups>
    </vminstance>


  • Sample Output JSON:
    {
       "vminstance" : {
         "@href" : "/api/juniper/vdirector/monitor/vms/{id}" ,
         "@uri" : "/api/juniper/vdirector/monitor/vms/{vi-id}" ,
         "cluster-name" : "String" ,
         "v-cpus" : "Integer" ,
         "dc-name" : "String" ,
         "cpu-usage" : "Integer" ,
         "ipaddress" : "String" ,
         "guest-mem-usage" : "Integer" ,
         "id" : "Integer" ,
         "annotation" : "String" ,
         "vc-hostname" : "String" ,
         "name" : "String" ,
         "resource-pool-name" : "String" ,
         "device-id" : "Integer" ,
         "vc-name" : "String" ,
         "vm-type" : "String" ,
         "host-mem-usage" : "Integer" ,
         "alloc-mem" : "Integer" ,
         "hostname" : "String" ,
         "vm-provision-initiator" : "String" ,
         "vi-id" : "String" ,
         "v-nics" : "Integer" ,
         "time-modified" : "java.util.Date" ,
         "vm-status" : "String" ,
         "vm-host-name" : "String" ,
         "folder-name" : "String" ,
         "uuid" : "String" ,
         "attributes" : {
           "attribute" : "String"
         } ,
         "port-groups" : {
           "port-group" : "String"
         }
       }
    }