Contents of the stats item in Rest API V1 | Nutanix Community
Skip to main content

I used Rest API V1 to get the VM information. There is information named stats in the acquired information. But I can't find a description of the items in stats. Does anyone know the website or any information that has this information?

Hey, @itg_sgedl00604-58313 all the documentation related to REST APIs on Nutanix resides at the below links:

 

https://www.nutanix.dev/reference/prism_element/v2/

 

https://www.nutanix.dev/

 

I hope this helps.:sweat_smile:

Hello Anish,
Thank you for your reply!

I also looked at the website, but I couldn't find any mention of the contents of the stats item.
If you like, can you tell me the url that describes the contents of the stats item?

best Regard.:bow_tone1:

Hi there!

Go to Prism Element REST API Explorer (gear icon dropdown) and at the top right corner choose API v1 version.

v1/vms/ will give you an example of stats (interpreting them is a different story):

"stats": {
        "hypervisor_avg_io_latency_usecs": "0",
        "num_read_iops": "-1",
        "hypervisor_write_io_bandwidth_kBps": "0",
        "timespan_usecs": "-1",
        "controller_num_read_iops": "0",
        "controller.storage_tier.ssd.usage_bytes": "756051968",
        "read_io_ppm": "-1",
        "controller_num_iops": "0",
        "hypervisor_memory_assigned_bytes": "-1",
        "total_read_io_time_usecs": "-1",
        "controller_total_read_io_time_usecs": "0",
        "controller.storage_tier.ssd.configured_pinned_bytes": "0",
        "hypervisor_num_io": "0",
        "controller_total_transformed_usage_bytes": "0",
        "hypervisor_cpu_usage_ppm": "25226",
        "controller_num_write_io": "1",
        "avg_read_io_latency_usecs": "-1",
        "guest.memory_swapped_in_bytes": "0",
        "controller_total_io_time_usecs": "1022",
        "memory_usage_ppm": "87138",
        "controller_total_read_io_size_kbytes": "0",
        "controller_num_seq_io": "-1",
        "controller_read_io_ppm": "0",
        "controller_total_io_size_kbytes": "4",
        "hypervisor.cpu_ready_time_ppm": "231",
        "controller_num_io": "1",
        "hypervisor_avg_read_io_latency_usecs": "0",
        "num_write_iops": "-1",
        "controller_num_random_io": "0",
        "num_iops": "-1",
        "guest.memory_usage_ppm": "87138",
        "hypervisor_num_read_io": "0",
        "hypervisor_total_read_io_time_usecs": "0",
        "controller_avg_io_latency_usecs": "1022",
        "num_io": "-1",
        "controller_num_read_io": "0",
        "hypervisor_num_write_io": "0",
        "controller_seq_io_ppm": "-1",
        "guest.memory_usage_bytes": "711401472",
        "controller_read_io_bandwidth_kBps": "0",
        "controller_io_bandwidth_kBps": "0",
        "hypervisor_num_received_bytes": "59617",
        "hypervisor_timespan_usecs": "44193851",
        "hypervisor_num_write_iops": "0",
        "total_read_io_size_kbytes": "-1",
        "hypervisor_total_io_size_kbytes": "0",
        "avg_io_latency_usecs": "-1",
        "hypervisor_num_read_iops": "0",
        "hypervisor_swap_in_rate_kBps": "-1",
        "controller_write_io_bandwidth_kBps": "0",
        "controller_write_io_ppm": "1000000",
        "controller_user_bytes": "48842076160",
        "hypervisor_avg_write_io_latency_usecs": "0",
        "hypervisor_num_transmitted_bytes": "444",
        "hypervisor_total_read_io_size_kbytes": "0",
        "read_io_bandwidth_kBps": "-1",
        "guest.memory_swapped_out_bytes": "0",
        "hypervisor_memory_usage_ppm": "1000000",
        "hypervisor_num_iops": "0",
        "hypervisor_io_bandwidth_kBps": "0",
        "controller_num_write_iops": "0",
        "total_io_time_usecs": "-1",
        "controller_random_io_ppm": "-1",
        "controller.storage_tier.das-sata.usage_bytes": "83346403328",
        "controller_avg_read_io_size_kbytes": "0",
        "hypervisor_swap_out_rate_kBps": "-1",
        "total_transformed_usage_bytes": "-1",
        "avg_write_io_latency_usecs": "-1",
        "num_read_io": "-1",
        "write_io_bandwidth_kBps": "-1",
        "hypervisor_read_io_bandwidth_kBps": "0",
        "hypervisor_consumed_memory_bytes": "-1",
        "random_io_ppm": "-1",
        "total_untransformed_usage_bytes": "-1",
        "hypervisor_total_io_time_usecs": "0",
        "num_random_io": "-1",
        "controller_avg_write_io_size_kbytes": "4",
        "controller_avg_read_io_latency_usecs": "0",
        "controller.storage_tier.das-sata.configured_pinned_bytes": "0",
        "num_write_io": "-1",
        "total_io_size_kbytes": "-1",
        "controller.storage_tier.cloud.usage_bytes": "0",
        "io_bandwidth_kBps": "-1",
        "controller_timespan_usecs": "30000000",
        "num_seq_io": "-1",
        "seq_io_ppm": "-1",
        "write_io_ppm": "-1",
        "controller_avg_write_io_latency_usecs": "1022"
      },


 

Hello Alona,

Thank you for your reply!I was able to get items of contents in stats! I will check these items. Thank you so much!

Terms & Conditions