Get Matching Resources Using POST

Get Matching Resources Using POST

Gets a listing of resources based on the query spec specified

Request
URI
POST
https://{api_host}/api/resources/query
COPY
Query Parameters
integer
page
Optional

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional

Expected number of entries per page


Request Body

Query spec that encapsulates various filtering criteria for looking up Resources

resource-query of type(s) application/json
Required
{
    "adapterInstanceId": [
        "string"
    ],
    "adapterKind": [
        "string"
    ],
    "collectorId": [
        0
    ],
    "collectorName": [
        "string"
    ],
    "credentialId": [
        "string"
    ],
    "includeRelated": "string",
    "maintenanceScheduleId": [
        "string"
    ],
    "name": [
        "string"
    ],
    "parentId": [
        "string"
    ],
    "propertyConditions": {
        "conditions": [
            {
                "doubleValue": "number",
                "key": "string",
                "operator": "string",
                "stringValue": "string"
            }
        ],
        "conjunctionOperator": "string"
    },
    "propertyName": "string",
    "propertyValue": "string",
    "recentlyAdded": 0,
    "regex": [
        "string"
    ],
    "resourceHealth": [
        "string"
    ],
    "resourceId": [
        "string"
    ],
    "resourceKind": [
        "string"
    ],
    "resourceState": [
        "string"
    ],
    "resourceStatus": [
        "string"
    ],
    "resourceTag": [
        {
            "category": "string",
            "name": "string"
        }
    ],
    "statConditions": {
        "conditions": [
            {
                "doubleValue": "number",
                "key": "string",
                "operator": "string",
                "stringValue": "string"
            }
        ],
        "conjunctionOperator": "string"
    },
    "statKey": "string",
    "statKeyInclusive": false,
    "statKeyLowerBound": "number",
    "statKeyUpperBound": "number"
}
array of string
adapterInstanceId
Optional

Array of uuids that identify adapter instances

array of string
adapterKind
Optional

Array of Adapter Kind keys

array of integer
collectorId
Optional

Array of Collector Identifiers

array of string
collectorName
Optional

Array of Collector names

array of string
credentialId
Optional

Array of CredentialIDs

string
includeRelated
Optional

None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.

Possible values are : PARENT, CHILD,
array of string
maintenanceScheduleId
Optional

Array of {@link UUID} that identify Maintenance Schedules. Since vROps 6.1.0 release onwards, we don't support search and look up of Resources using Maintenance Schedules' identifiers.

array of string
name
Optional

Array of resource names to query for. NOTE: Currently, only single element supported

array of string
parentId
Optional

Array of UUID of object that are the parent resource in a parent child relationship

propertyConditions
Optional

Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator

string
propertyName
Optional

Name of property. Query only supports filtering for a single property.

string
propertyValue
Optional

Value of property. Omitting the property value will check for existence of the property name on the resource. NOTE: Use 'propertyConditions' to specify lookup of Resource using multiple properties.

integer As int64 As int64
recentlyAdded
Optional

Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.

array of string
regex
Optional

Array of resource names in java regex format. NOTE: regex and name are mutually exclusive. If both are specified, name is given preference.

array of string
resourceHealth
Optional

Array of resource health

Possible values are : GREEN, YELLOW, ORANGE, RED, GREY,
array of string
resourceId
Optional

Array of Resource Identifiers

array of string
resourceKind
Optional

Array of Resource Kind keys

array of string
resourceState
Optional

Array of resource states

Possible values are : STOPPED, STARTING, STARTED, STOPPING, UPDATING, FAILED, MAINTAINED, MAINTAINED_MANUAL, REMOVING, NOT_EXISTING, NONE, UNKNOWN,
array of string
resourceStatus
Optional

Array of resource data collection stats

Possible values are : NONE, ERROR, UNKNOWN, DOWN, DATA_RECEIVING, OLD_DATA_RECEIVING, NO_DATA_RECEIVING, NO_PARENT_MONITORING, COLLECTOR_DOWN,
resourceTag
Optional

Property used for tag filtering. NOTE: If specified, only the resources with the tags will be returned.

statConditions
Optional

Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator

string
statKey
Optional

Name of resource StatKey to validate value is within a range. Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions NOTE: Use 'statConditions' to specify lookup of Resource using multiple stat keys.

boolean
statKeyInclusive
Optional

Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true

number As double As double
statKeyLowerBound
Optional

StatKey value matching range lower bound

number As double As double
statKeyUpperBound
Optional

StatKey value matching range upper bound

Authentication
This operation uses the following authentication methods.
Responses
200

The Collection of Resources matching the specified query parameters

Returns resources of type(s) application/json
{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "resourceList": [
        {
            "badges": [
                {
                    "color": "string",
                    "score": "number",
                    "type": "string"
                }
            ],
            "creationTime": 0,
            "credentialInstanceId": "string",
            "description": "string",
            "dtEnabled": false,
            "extension": {
                "anyObjects": [
                    {}
                ]
            },
            "geoLocation": {
                "latitude": "number",
                "longitude": "number"
            },
            "identifier": "string",
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "monitoringInterval": 0,
            "monitoringIntervalMinutes": 0,
            "monitoringIntervalSeconds": 0,
            "relatedResources": [
                "string"
            ],
            "resourceHealth": "string",
            "resourceHealthValue": "number",
            "resourceKey": {
                "adapterKindKey": "string",
                "extension": {
                    "anyObjects": [
                        {}
                    ]
                },
                "links": [
                    {
                        "description": "string",
                        "href": "string",
                        "name": "string",
                        "rel": "string"
                    }
                ],
                "name": "string",
                "resourceIdentifiers": [
                    {
                        "identifierType": {
                            "dataType": "string",
                            "extension": {
                                "anyObjects": [
                                    {}
                                ]
                            },
                            "isPartOfUniqueness": false,
                            "links": [
                                {
                                    "description": "string",
                                    "href": "string",
                                    "name": "string",
                                    "rel": "string"
                                }
                            ],
                            "name": "string"
                        },
                        "key": "string",
                        "links": [
                            {
                                "description": "string",
                                "href": "string",
                                "name": "string",
                                "rel": "string"
                            }
                        ],
                        "name": "string",
                        "uniquelyIdentifying": false,
                        "value": "string"
                    }
                ],
                "resourceKindKey": "string"
            },
            "resourceStatusStates": [
                {
                    "adapterInstanceId": "string",
                    "resourceState": "string",
                    "resourceStatus": "string",
                    "statusMessage": "string"
                }
            ]
        }
    ]
}
array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result

array of resource
resourceList
Optional

The Collection of Resources


Resources Operations
POST
Add Group Type Using POST
POST
Add Resources Properties Using Adapter Kind Using POST
POST
Add Resources Properties Using POST
POST
Add Stats For Resources Using POST
POST
Add Stats For Resources Using Push Adapter Kind Using POST
POST
Create Custom Group Using POST
POST
Create Custom Profile Using POST
POST
Create Resource Using Adapter Instance Using POST
POST
Create Resource Using Adapter Kind Using POST
DELETE
Delete Custom Group Using DELETE
DELETE
Delete Custom Profile Using DELETE
DELETE
Delete Group Type Using DELETE
DELETE
Delete Resources Using DELETE
GET
Get Custom Group Members Using GET
GET
Get Custom Groups Using GET
GET
Get Custom Group Using GET
GET
Get Custom Profiles Using GET
GET
Get Custom Profile Using GET
GET
Get Group Types Using GET
GET
Get Latest Stats Of Resources Using GET
POST
Get Matching Resources Using POST
GET
Get Resource Properties List Using GET
POST
Get Resources Relationships Using POST
GET
Get Resources Using GET
GET
Get Stat Keys Of Resources Using GET
POST
Get Stats And DT For Resources Using POST
POST
Get Stats For Resources Using POST
GET
Get Stats Of Resources Using GET
GET
Get Top N Stats Of Resources Using GET
PUT
Mark Resources As Being Maintained Using PUT
PUT
Modify Custom Group Using PUT
PUT
Modify Custom Profile Using PUT
POST
Query Latest Properties Of Resources Using POST
POST
Query Latest Stats Of Resources Using POST
PUT
Start Monitoring Resources Using PUT
PUT
Stop Monitoring Resources Using PUT
DELETE
Unmark Resources As Being Maintained Using DELETE
PUT
Update Resource Using PUT