grid:cloudapi:cloudstatistics : Grid Cloud Statistics object.

Represents the cloud statistics data.

Object Reference

References to grid:cloudapi:cloudstatistics are object references. The name part of a Grid Cloud Statistics object reference has the following components:

  • The “CloudStatistics” string

Example: grid:cloudapi:cloudstatistics/ZGldHdvcmtfdmlldyQxMTk:CloudStatistics

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Read by object reference
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): allocated_available_ratio, allocated_ip_count, available_ip_count, fixed_ip_count, floating_ip_count, tenant_count, tenant_ip_count, tenant_vm_count.

allocated_available_ratio

allocated_available_ratio

Ratio of allocated vs. available IPs

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The allocated_available_ratio is part of the base object.

The allocated_available_ratio cannot be updated.

allocated_available_ratio cannot be written.

allocated_ip_count

allocated_ip_count

Total number of IPs allocated by tenants.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The allocated_ip_count is part of the base object.

The allocated_ip_count cannot be updated.

allocated_ip_count cannot be written.

available_ip_count

available_ip_count

The total number of IP addresses available to tenants. Only IP addresses in networks that are within a delegation scope are counted.

Type

String.

Search

The field is not available for search.

Notes

The available_ip_count is part of the base object.

The available_ip_count cannot be updated.

available_ip_count cannot be written.

fixed_ip_count

fixed_ip_count

The total number of fixed IP addresses currently in use by all tenants in the system.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The fixed_ip_count is part of the base object.

The fixed_ip_count cannot be updated.

fixed_ip_count cannot be written.

floating_ip_count

floating_ip_count

The total number of floating IP addresses currently in use by all tenants in the system.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The floating_ip_count is part of the base object.

The floating_ip_count cannot be updated.

floating_ip_count cannot be written.

tenant_count

tenant_count

Total number of tenant currently in the system.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The tenant_count is part of the base object.

The tenant_count cannot be updated.

tenant_count cannot be written.

tenant_ip_count

tenant_ip_count

The total number of IP addresses currently in use by all tenants in the system.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The tenant_ip_count is part of the base object.

The tenant_ip_count cannot be updated.

tenant_ip_count cannot be written.

tenant_vm_count

tenant_vm_count

The total number of VMs currently in use by all tenants in the system.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The tenant_vm_count is part of the base object.

The tenant_vm_count cannot be updated.

tenant_vm_count cannot be written.

Fields List

Field Type Req R/O Base Search
allocated_available_ratio Unsigned int N Y Y N/A
allocated_ip_count Unsigned int N Y Y N/A
available_ip_count String N Y Y N/A
fixed_ip_count Unsigned int N Y Y N/A
floating_ip_count Unsigned int N Y Y N/A
tenant_count Unsigned int N Y Y N/A
tenant_ip_count Unsigned int N Y Y N/A
tenant_vm_count Unsigned int N Y Y N/A