Jump to

• Request
• Response

Find ReadOnly Cluster By Name

get

/essbase/rest/v1/rocluster/findByName

Returns the named ReadOnly cluster from Essbase domain db. Provide the URL encoded String value as input(clusterName)

Request

Query Parameters

• clusterName: string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

ReadOnly cluster retrived sucessfully.

Body ()

Root Schema : ROCluster

Type: object

Show Source

• desc: string
• items: array items
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ClusterNode"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ClusterNode"
    }
}

Nested Schema : items

Type: object

Show Source

• agentUrl: string
• appName: string
• dbName: string
• machineName: string
• state: integer(int32)

{
    "type":"object",
    "properties":{
        "machineName":{
            "type":"string"
        },
        "appName":{
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "state":{
            "type":"integer",
            "format":"int32"
        },
        "agentUrl":{
            "type":"string"
        }
    },
    "xml":{
        "name":"items"
    }
}

400 Response

Bad Request

Failed to retrive the Readonly cluster. Incorrect/missing cluster name

500 Response

Internal Server Error.

Back to Top