Jump to

• Request
• Response

Create ReadOnly Cluster

post

/essbase/rest/v1/rocluster

Adds new ReadOnly cluster with all selected nodes and description to the domain db of Essbase server.

Request

Body ()

RoCluster

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"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Sucessfully created the ReadOnly cluster

400 Response

Bad Request

Failed the create ReadOnly cluster.JSON may be incorrect or name or node info is missing

500 Response

Internal Server Error.

Back to Top