Previous Next JavaScript must be enabled to correctly display this content

## await-consistent

post

/V0/nosql/admin#await-consistent

Waits for up to the specified number of seconds for the replicas in one or more zones, or in the entire store, to catch up with the masters in their associated shards. Prints information about whether consistency was achieved or, if not, details about which nodes failed to become consistent.

### Request

There are no request parameters for this operation.

Supported Media Types

- application/json

Request Body - application/json ()
Root Schema : schema
Type: `object`
Show Source

- arguments: array arguments
- command(required): string
  Allowed Values: `[ "await-consistency" ]`

    {
        "required":[
            "command"
        ],
        "properties":{
            "command":{
                "type":"string",
                "enum":[
                    "await-consistency"
                ]
            },
            "arguments":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "argumentName":{
                            "type":"string"
                        },
                        "argumentValue":{
                            "oneOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"boolean"
                                }
                            ]
                        }
                    }
                }
            }
        },
        "example":{
            "command":"await-consistency",
            "arguments":[
                {
                    "timeout":"Timeout value in seconds"
                },
                {
                    "zn":"Id of the zone"
                },
                {
                    "replicaDelayThreshold":"Allowed replica delay time in milliseconds"
                }
            ]
        }
    }

Example:

    {
        "command":"await-consistency",
        "arguments":[
            {
                "timeout":"Timeout value in seconds"
            },
            {
                "zn":"Id of the zone"
            },
            {
                "replicaDelayThreshold":"Allowed replica delay time in milliseconds"
            }
        ]
    }

Nested Schema : arguments
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "argumentName":{
                    "type":"string"
                },
                "argumentValue":{
                    "oneOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"boolean"
                        }
                    ]
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- argumentName: string
- argumentValue: argumentValue

    {
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }

Nested Schema : argumentValue
Match One Schema
Show Source

- string
- boolean

    {
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"boolean"
            }
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Operation ended successfully
Body ()
Root Schema : commonResponse
Type: `object`
Show Source

- description(required): string
- operation(required): string
- returnCode(required): string
- returnValue(required): object returnValue

    {
        "properties":{
            "operation":{
                "type":"string"
            },
            "returnCode":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "returnValue":{
                "type":"object"
            }
        },
        "example":{
            "operation":"operation executed",
            "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
            "description":"error description when returnCode != 5000",
            "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
        },
        "required":[
            "operation",
            "returnCode",
            "description",
            "returnValue"
        ]
    }

Example:

    {
        "operation":"operation executed",
        "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
        "description":"error description when returnCode != 5000",
        "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
    }

Nested Schema : returnValue
Type: `object`
Back to Top