ComponentGroupQuery

ComponentGroupQuery
ComponentGroupQuery

Retrieves a list of component groups based on the provided query parameters. The body may include componentGroupResourceIds, componentGroupResourceFqdns, componentGroupResourceNames, policyIds, policyNames, componentGroups, and componentGroupComplianceStatuses.

Filtering Behavior: Parameters are combined using a logical OR. The system returns a deduplicated union of all matches. For example, if you query by componentGroups and componentGroupResourceIds, the response will include items that match the component group plus items that match the component group resource ID, with no duplicates.

Request JSON: Use the property componentGroups (plural) as a JSON array of strings (FLEET, MANAGEMENT, INSTANCE).

JSON Example
{
    "componentGroupComplianceStatuses": [
        "string"
    ],
    "componentGroupResourceFqdns": [
        "string"
    ],
    "componentGroupResourceIds": [
        "string"
    ],
    "componentGroupResourceNames": [
        "string"
    ],
    "componentGroups": [
        "string"
    ],
    "policyIds": [
        "string"
    ],
    "policyNames": [
        "string"
    ]
}
array of string
componentGroupComplianceStatuses
Optional
Constraints: minItems: 0 maxItems: 100

Compliance statuses of the component group

Enumeration: COMPLIANT, NON_COMPLIANT, NOT_ELIGIBLE, IN_PROGRESS, PENDING, FAILED, NO_POLICY, UNKNOWN
array of string
componentGroupResourceFqdns
Optional
Constraints: minItems: 0 maxItems: 100

Component Group resource FQDNs (example item: sddc-manager.cloud.example.com)

array of string
componentGroupResourceIds
Optional
Constraints: minItems: 0 maxItems: 100

Component group resource IDs

array of string
componentGroupResourceNames
Optional
Constraints: minItems: 0 maxItems: 100

Component Group resource names

array of string
componentGroups
Optional
Constraints: minItems: 0 maxItems: 100

JSON componentGroups (plural): array of FLEET, MANAGEMENT, INSTANCE.

Enumeration: FLEET, MANAGEMENT, INSTANCE, UNKNOWN
array of string
policyIds
Optional
Constraints: minItems: 0 maxItems: 100

Policy IDs

array of string
policyNames
Optional
Constraints: minItems: 0 maxItems: 100

Policy names