Path parameters

• deployment_id string Required

  Identifier for the Deployment.

• ref_id string Required

  User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

• restore_snapshot boolean

  When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).

  Default value is true.

• skip_snapshot boolean

  If true, will not take a snapshot of the cluster before restarting.

  Default value is true.

• cancel_pending boolean

  If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.

  Default value is false.

• group_attribute string

  Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '__all__' (restart all at once), '__zone__' by logical zone, '__name__' one instance at a time, or a comma-separated list of attributes of the instances

  Default value is __zone__.

• shard_init_wait_time integer

  The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)

  Default value is 600.

Responses

• 202 application/json

  The restart command was issued successfully.

  Hide response attribute Show response attribute object

  • warnings array[object]

    List of warnings generated from validating command

    Hide warnings attributes Show warnings attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string

      A human readable message describing the warning that occurred

• 404 application/json
  • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
  • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 422 application/json

  The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: deployments.deployment_resource_plan_change_error)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_resource_plan_change_error.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 500 application/json

  A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_resource_no_longer_exists.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields