Get Configs

Get Configs

Get configs associated with the given criteria, all if no criteria is provided

Request
URI
GET
https://{api_host}/v1/config-drifts
COPY
Query Parameters
string
resourceId
Optional

Resource Id

string
resourceType
Optional

Resource Type

string
configId
Optional

Config Id

string
driftType
Optional

Drift Type

integer
size
Optional

Size of the page to retrieve. Default page size is 10. Optional

integer
page
Optional

Page number to retrieve. Default page 0 will retrieve all elements. Optional

Responses
200

OK

Returns PageOfConfigDriftSpec of type(s) application/json 
{
    "elements": [
        {
            "id": "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
            "name": "Distributed Virtual Portgroup configuration drift",
            "description": "This drift operation will create an additional distributed virtual port group on a cluster for VCF management VM communication, and migrate VCF-managed VMs to this new port group",
            "resourceType": "system | domain | cluster | host | edge_cluster",
            "type": "fix | feature",
            "applicability": {
                "versionApplicability": [
                    {
                        "productType": "SDDC_MANAGER|VCENTER|ESXI|NSXT_MANAGER|VXRAIL",
                        "minVersion": "string",
                        "maxVersion": "string"
                    }
                ],
                "skuType": "OPTIONS: VXRAIL|VSAN|VSRN_VXRAIL"
            }
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of ConfigDriftSpec
elements
Optional

The list of elements included in this page

PageMetadata
pageMetadata
Optional

Represents pageable elements pagination metadata


500

Internal Server Error

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.

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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.


503

Internal Service Unavailable

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.

object
context
Optional

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

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

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.


On This Page
Config Reconciler Operations
GET
Get Configs
GET
Get Reconciliation Task
POST
Reconcile Configs