Fetch Cluster By Names
This API is to be used for fetching the Clusters based on Cluster names.
Request
URI
POST
https://{api_host}/hybridity/api/ztp/v1/clusters/fetch-by-names
COPY
Request Body
The request payload for Fetch Clusters By Names API.
InlineZtpV1ClustersFetchByNamesRequestBody of type(s) application/json
Required
{
"clusters": [
"string"
]
}array of string
clusters
Required
The name of the Clusters.
Responses
200
Response includes list of cluster as specified by the cluster names.
Returns InlineZtpV1ClustersFetchByNames200Response of type(s) application/json
{
"clusters": [
{
"id": "string",
"version": 0,
"name": "string",
"type": "string",
"enabled": false,
"parentDomainId": "string",
"parentDomainName": "cdc1",
"location": {
"city": "string",
"country": "string",
"address": "string",
"longitude": "number",
"latitude": "number"
},
"licenses": {
"esxi": [
"string"
],
"vsan": [
"string"
]
},
"switches": [
{
"name": "string",
"uplinks": [
{
"pnic": "string",
"name": "string"
}
]
}
],
"services": [
{
"name": "string",
"type": "string",
"enabled": false,
"vsanConfig": {
"vsanDedup": false
}
}
],
"storage": {
"twoNodeVsanCluster": {
"witness": {
"preDeployed": {
"witnessHostAddress": "string"
},
"ztpDeployed": {
"ovaPath": "string",
"witnessVMDeployment": {
"formFactor": "string",
"deploymentTarget": {
"clusterName": "string",
"resourceGroup": "string",
"hostName": "string"
},
"dataStoreName": "string",
"primaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"secondaryNetwork": {
"networkName": "string",
"fqdn": "string",
"gateway": "string",
"prefix": 0
},
"rootPassword": "string"
}
}
}
}
},
"networks": [
{
"type": "string",
"name": "string",
"switch": "string",
"segmentType": "string",
"vlan": 0,
"mtu": 0,
"gateway": "string",
"prefixLength": 0,
"mac_learning_enabled": false,
"uplinkTeamingPolicy": {
"uplinkPortOrder": {
"active": [
"string"
],
"standby": [
"string"
],
"unused": [
"string"
]
}
}
}
],
"settings": {
"dns": {
"suffix": "string",
"servers": [
"string"
]
},
"ntp": {
"servers": [
"string"
]
},
"csiTagging": {
"enableCsiZoning": false,
"clusterCsiZoneTagNamingScheme": "string",
"hostCsiZoneTagNamingScheme": "string"
},
"disableDatastoreCustomization": false
},
"csiTags": {
"csiZoneTag": "string"
},
"csiCategories": {
"useExisting": false,
"zone": "string"
},
"hcpId": "string",
"hcpName": "string",
"hostCount": 0,
"status": "string",
"createdTimestamp": 0,
"lastUpdatedTimestamp": 0,
"messages": {
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}
}
],
"notfound": [
"string"
]
}array of object
clusters
Optional
The list of clusters available.
array of string
notfound
Optional
The list of cluster names which are not available.
301
API endpoint has permanently moved.
Returns InlineZtpV1ClustersFetchByNames301Response of type(s) application/json
{
"redirectURL": "string"
}string
redirectURL
Optional
redirectURL
Response Headers
string
Location
URI where the client will find the new endpoint.
400
Response may include details of why the request is bad.
Returns InlineZtpV1ClustersFetchByNames400Response of type(s) application/json
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}array of object
warnings
Optional
The list of warnings.
array of object
errors
Optional
The list of errors.
401
User is not authenticated to invoke this endpoint.
Operation doesn't return any data structure
403
User is not authorized to invoke this endpoint.
Operation doesn't return any data structure
422
The request payload couldn't be processed by the server.
Returns InlineZtpV1ClustersFetchByNames422Response of type(s) application/json
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}array of object
warnings
Optional
The list of warnings.
array of object
errors
Optional
The list of errors.
500
An internal server error has occurred.
Returns InlineZtpV1ClustersFetchByNames500Response of type(s) application/json
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}array of object
warnings
Optional
The list of warnings.
array of object
errors
Optional
The list of errors.