capacityreport : Grid member capacity report object.¶
The capacity report object provides information about the object count, interface count, and other memory usage statistics for a Grid member.
Object Reference¶
References to capacityreport are object references.
The name part of a capacity report reference has the following components:
The capacity report member host name.
Example: capacityreport/ZG5zLm5ldHdvcmtfdmlldyQxMTk:member1.x
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Permissions
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): name, percent_used, role.
hardware_type¶
- hardware_type¶
Hardware type of a Grid member.
Type
String.
Search
The field is not available for search.
Notes
The hardware_type cannot be updated.
hardware_type cannot be written.
max_capacity¶
- max_capacity¶
The maximum amount of capacity available for the Grid member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The max_capacity cannot be updated.
max_capacity cannot be written.
name¶
- name¶
The Grid member name.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
object_counts¶
- object_counts¶
A list of instance counts for object types created on the Grid member.
Type
A/An Type count struct struct array.
Search
The field is not available for search.
Notes
The object_counts cannot be updated.
object_counts cannot be written.
percent_used¶
- percent_used¶
The percentage of the capacity in use by the Grid member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The percent_used is part of the base object.
The percent_used cannot be updated.
percent_used cannot be written.
role¶
- role¶
The Grid member role.
Type
String.
Search
The field is not available for search.
Notes
The role is part of the base object.
The role cannot be updated.
role cannot be written.
total_objects¶
- total_objects¶
The total number of objects created by the Grid member.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The total_objects cannot be updated.
total_objects cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
hardware_type |
String |
N |
Y |
N |
N/A |
max_capacity |
Unsigned int |
N |
Y |
N |
N/A |
name |
String |
N |
Y |
Y |
= |
object_counts |
[struct] |
N |
Y |
N |
N/A |
percent_used |
Unsigned int |
N |
Y |
Y |
N/A |
role |
String |
N |
Y |
Y |
N/A |
total_objects |
Unsigned int |
N |
Y |
N |
N/A |
