Get Criterion | VMware Cloud Foundation for VxRail API

Get Criterion

Get a criterion

Request

URI

GET

https://{api_host}/v1/hosts/criteria/{name}

COPY

Path Parameters

string

name

Required

name

Responses

200

Returns HostCriterion of type(s) application/json

{
    "name": "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY",
    "subCriteria": [
        "HostCriterion Object"
    ],
    "arguments": {
        "arguments": "string"
    },
    "description": "string"
}

string

name

Optional

Name of the criterion

array of HostCriterion

subCriteria

Optional

Collection of sub-criterion supported on this criterion

object

arguments

Optional

Arguments required for a particular criterion

string

description

Optional

Description of the criterion

404

Criterion Not Found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

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