Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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')

required

Code Block
languagejson
{
    "params": {
        "configuration_id": 1,
        "role": "primary"
    }
}

...

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

Code Block
languagejson
{
    "error": {
        "message": "string"
    },
    "result": {
        "message": "string"
    },
    "successful": true
}

...

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

Code Block
languagejson
{
    "error": {
        "message": "string"
    },
    "successful": false
}