1.3.16 Members of a consumer
This section explains the Members of a consumer (Groups resource).
| Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by) |
|---|---|---|---|---|---|
| instanceID | long | ID for identifying instances | N | Y | Y |
| name | string | Consumer name. Use 128 or fewer characters. | Y | Y | Y |
| status | enum | Status of the consumer. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators. The specifiable values are as follows:
|
N | N | N |
| gradeKey | string | ID for identifying grades | Y | Y | Y |
| gradeName | string | Grade name | N | N | N |
| gradeDisplayOrder | integer | Priority of the grade | N | N | N |
| description | string | Description of the consumer. Use 1000 or fewer characters. | Y | Y | Y |
| urls | string[] | URL | Y | N | N |
| urlDisplayNames | string[] | Character string displayed for the URL | Y | N | N |
| templateCreatorType | enum | Change type of the consumer. For details about the specifiable values, see the table TemplateCreatorType in 1.6 List of enumerators. | Y (only when a new profile is created) | Y (only to eq, ne, in, not in) | N |
| vmAutoAssignment | boolean | Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically | Y | N | N |
| applicationAssignFollow | boolean | Set true if you assign a application under the resource that belong to this Group automatically | Y | N | N |
| numOfVolumes | integer | Number of volumes to which the consumer is assigned. | N | N | N |
| numOfVMs | integer | Number of virtual machines to which the consumer is assigned | N | N | N |
| numOfHosts | integer | Number of hosts to which the consumer is assigned | N | N | N |
| numOfHypervisors | integer | Number of hypervisors to which the consumer is assigned | N | N | N |
| numOfApplications | integer | Number of applications to which the consumer is assigned | N | N | N |
| numOfPods | integer | Number of pods to which the consumer is assigned | N | N | N |
| numOfInstances | integer | Number of instances to which the consumer is assigned. | N | N | N |
| vmAutoAssignFilters | string[] | Name of the automatic assignment rule set for the virtual machines | N | N | N |
| hostAutoAssignFilters | string[] | Name of the automatic assignment rule set for the hosts | N | N | N |
| podAutoAssignFilters | string[] | Name of the automatic assignment rule set for the pods | N | N | N |
| instanceAutoAssignFilters | string[] | Name of the automatic assignment rule set for the instances | N | N | N |
(Legend) Y: Applicable, N: Not applicable