Get Cluster By Name

Get Cluster By Name

List the setting of an OpenStack cluster

Request
URI
GET
https:////192.168.111.151:8443/v1/clusters/{clusterName}
COPY
Path Parameters
string
clusterName
Required

clusterName

Query Parameters
boolean
details
Optional

details


Responses
200

OK

Returns ClusterRead of type(s) application/json
{
    "buildNumber": "string",
    "instanceNum": "integer",
    "name": "string",
    "nodeGroups": [
        {
            "cpuNum": "integer",
            "instanceNum": "integer",
            "instances": [
                {
                    "action": "string",
                    "actionFailed": "boolean",
                    "cpuNumber": "integer",
                    "errMessage": "string",
                    "hostName": "string",
                    "memory": "integer",
                    "moId": "string",
                    "name": "string",
                    "rack": "string",
                    "roles": [
                        "string"
                    ],
                    "status": "string",
                    "targetSystemDs": "string",
                    "version": "string",
                    "volumes": [
                        "string"
                    ]
                }
            ],
            "memCapacityMB": "integer",
            "name": "string",
            "networking": {
                "allIpBlocks": [
                    {
                        "beginIp": "string",
                        "endIp": "string"
                    }
                ],
                "assignedIpBlocks": [
                    {
                        "beginIp": "string",
                        "endIp": "string"
                    }
                ],
                "dhcp": "boolean",
                "dns1": "string",
                "dns2": "string",
                "freeIpBlocks": [
                    {
                        "beginIp": "string",
                        "endIp": "string"
                    }
                ],
                "gateway": "string",
                "ipAllocEntries": [
                    {
                        "clusterId": "integer",
                        "clusterName": "string",
                        "ipAddress": "string",
                        "nodeGroupId": "integer",
                        "nodeGroupName": "string",
                        "nodeId": "integer",
                        "nodeName": "string"
                    }
                ],
                "name": "string",
                "netmask": "string",
                "portGroup": "string"
            },
            "roles": [
                "string"
            ],
            "services": [
                "string"
            ],
            "storage": {
                "allocType": "string",
                "controllerType": "string",
                "diskstoreNamePattern": [
                    "string"
                ],
                "dsNames": [
                    "string"
                ],
                "dsNames4Data": [
                    "string"
                ],
                "dsNames4System": [
                    "string"
                ],
                "imagestoreNamePattern": [
                    "string"
                ],
                "sizeGB": "integer",
                "splitPolicy": "string",
                "type": "string"
            },
            "swapRatio": "number"
        }
    ],
    "resourcePools": [
        {
            "nodes": [
                {
                    "action": "string",
                    "actionFailed": "boolean",
                    "cpuNumber": "integer",
                    "errMessage": "string",
                    "hostName": "string",
                    "memory": "integer",
                    "moId": "string",
                    "name": "string",
                    "rack": "string",
                    "roles": [
                        "string"
                    ],
                    "status": "string",
                    "targetSystemDs": "string",
                    "version": "string",
                    "volumes": [
                        "string"
                    ]
                }
            ],
            "rpName": "string",
            "rpVsphereName": "string",
            "totalCPUInMHz": "integer",
            "totalRAMInMB": "integer",
            "usedCPUInMHz": "integer",
            "usedRAMInMB": "integer",
            "vcCluster": "string"
        }
    ],
    "status": "string",
    "version": "string"
}
object
attributes
Optional

attributes

string
buildNumber
Optional

buildNumber

integer As int32 As int32
instanceNum
Optional

instanceNum

string
name
Optional

name

nodeGroups
Optional

nodeGroups

resourcePools
Optional

resourcePools

string
status
Optional

status

string
version
Optional

version


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure