All Products
Search

This Product

    PolarDB:RestartPolarClawGateway

    Document Center

    PolarDB:RestartPolarClawGateway

    Last Updated:Jul 18, 2026

    Restarts a PolarClaw gateway.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ApplicationId

    string

    Yes

    The application ID.

    pa-xxx
    Mode

    string

    No

    The restart mode. Valid values:

    • in-process: lightweight restart without applying environment variable changes. This is the default value.

    • pkill: cold start that applies environment variable changes.

    in-process

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    F45FFACC-xxx
    Message

    string

    The response message.

    successful
    Code

    integer

    The response status code.

    200
    ApplicationId

    string

    The application ID.

    pa-xxx
    Ok

    boolean

    Indicates whether the operation was successful.

    true
    Mode

    string

    The actual restart mode used.

    in-process
    Restarted

    boolean

    Indicates whether the gateway has been confirmed available after the restart. This value is returned synchronously.

    true
    GatewayVersion

    string

    The gateway version after the restart. This value is returned synchronously.

    2026.5.7
    DowntimeMs

    integer

    The approximate downtime of this restart, in milliseconds. This value is returned synchronously.

    3235
    TaskId

    string

    The asynchronous task ID. This value is returned when Async is set to true. You can poll the task status by calling DescribePolarClawTask.

    0ee00f56-f467-4d41-858c-ca4ede2c770e
    State

    string

    The initial state of the asynchronous task. This value is returned when Async is set to true.

    pending
    Operation

    string

    The operation name. This value is returned when Async is set to true.

    RestartPolarClawGateway

    Examples

    Success response

    JSON format

    {
  "RequestId": "F45FFACC-xxx",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-xxx",
  "Ok": true,
  "Mode": "in-process",
  "Restarted": true,
  "GatewayVersion": "2026.5.7",
  "DowntimeMs": 3235,
  "TaskId": "0ee00f56-f467-4d41-858c-ca4ede2c770e",
  "State": "pending",
  "Operation": "RestartPolarClawGateway"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.