Get Criterion

Get Criterion

Get a criterion

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/hosts/criteria/{name}
COPY
Path Parameters
string
name
Required

name

Responses
200

Ok

Returns HostCriterion of type(s) application/json 
{
    "description": "string",
    "name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"
}
object
arguments
Optional

Arguments required for a particular criterion

string
description
Optional

Description of the criterion

string
name
Optional

Name of the criterion


404

Criterion Not Found

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Hosts Operations
GET
Get Criteria
GET
Get Criterion
GET
Get Host
GET
Get Host Query Response 1
GET
Get Hosts
POST
Post Query