Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Stop the primary or standby cluster

Request

HTTP Method: POST
Content Type: application/json

Parameters

Property

Type

Description

Required

configuration_id

integer(int64)

configuration ID (non-negative)

required

role

string

cluster to stop (primary or standby) (possible values: 'primary' and 'standby')

{
    "params": {
        "configuration_id": 1,
        "role": "primary"
    }
}

Response

HTTP Status: 200

Content Type: application/json

Response

Property

Type

Description

error

object of type error_response

error response

result

object of type empty_result

empty result

successful

boolean

response with error or not

empty_result

Property

Type

Description

message

string

response message

error_response

Property

Type

Description

message

string

error message

{
    "error": {
        "message": "string"
    },
    "result": {
        "message": "string"
    },
    "successful": true
}

HTTP Status: 400

Content Type: application/json

Response

Property

Type

Description

error

object of type error_response

error response

successful

boolean

always false

error_response

Property

Type

Description

message

string

error message

{
    "error": {
        "message": "string"
    },
    "successful": false
}
  • No labels