Get Clusters
This API is to be used for getting the Clusters as per the specified parameters.
The key to use for sorting the resultant list of Clusters. The value is to be an attribute based sorting expression. The supported attributes for sorting are as follows: [ name, enabled, location, status, id, version, hcpId, parentDomainId, parentDomainName, createdTimestamp, lastUpdatedTimestamp ]. The supported sorting orders are: [asc,desc]
createdTimestamp,descAttribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The supported filter types are [cont, eq]. "cont" refers to contains (substring check). It is applicable only for string type targets. "eq" refers to exact match. If target type is a string, then case is ignored. The supported attributes for "eq" filtering are: [name, enabled, location, status, id, version, hcpId, parentDomainId, parentDomainName]. The supported attributes for "cont" filtering are: [name, enabled, location, status, id, hcpId, parentDomainId, parentDomainName].
(cont,name,cluster);(eq,parentDomainName,cdc)Marker to obtain the next page of a paged response according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource. The marker expression will contain page number and page size.
page_no=1,page_size=10Response includes list of Cluster as specified by the request parameters.
[
{
"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"
}
]
}
}
]Response Headers
The total number of pages for Cluster present on the server with the applied filters.
The total number of Cluster present on the server with the applied filters.
The total number of Cluster present on the server.
API endpoint has permanently moved.
{
"redirectURL": "string"
}redirectURL
Response Headers
URI where the client will find the new endpoint.
Response may include details of why the request is bad.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}The list of warnings.
The list of errors.
User is not authenticated to invoke this endpoint.
User is not authorized to invoke this endpoint.
The request parameters couldn't be processed by the server.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}The list of warnings.
The list of errors.
An internal server error has occurred.
{
"warnings": [
{
"code": "string",
"message": "string",
"stack": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"stack": "string"
}
]
}The list of warnings.
The list of errors.