• Data Warehouse Service

dws
  1. Help Center
  2. Data Warehouse Service
  3. API Reference
  4. API Description
  5. Snapshot Management APIs
  6. Restoring a Cluster

Restoring a Cluster

Function

This API is used to restore clusters using the snapshot.

URI

  • URI format

    POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    snapshot_id

    Yes

    String

    Snapshot ID

Request

  • Sample request
    POST /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
    {"restore": {
            "name": "dws-1",
            "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
            "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
            "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
            "availability_zone": "eu-de-01",
            "port": 8000,
            "public_ip": {
                "public_bind_type": "auto_assign",
                "eip_id": ""
            }
        }
    }
  • Parameter description
    Table 2 Request parameter description

    Parameter

    Mandatory

    Type

    Description

    restore

    Yes

    Object

    Object to be restored

    name

    Yes

    String

    Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which consist of letters, digits, hyphens (-), or underscores (_) only and must start with a letter.

    subnet_id

    No

    String

    Subnet ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

    vpc_id

    No

    String

    VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

    security_group_id

    No

    String

    ID of a security group. The ID is used for configuring cluster network. The default value is the same as that of the original cluster.

    availability_zone

    No

    String

    AZ of a cluster. The default value is the same as that of the original cluster.

    port

    No

    Integer

    Service port of a cluster (8000 to 10000). The default value is 8000.

    public_ip

    No

    Object

    Public IP address. If the value is not specified, public connection is not used by default.

    public_bind_type

    No

    String

    Binding type of an EIP. The value can be either of the following:

    • auto_assign
    • not_use
    • bind_existing

    The default value is not_use.

    eip_id

    No

    UUID

    EIP ID The default value is the same as that of the original cluster.

Response

  • Sample response
    {
        "cluster": {
            "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
         }
    }
  • Parameter description
    Table 3 Response parameter description

    Parameter

    Mandatory

    Type

    Description

    cluster

    Yes

    Object

    Cluster object

    id

    Yes

    String

    Cluster ID

Returned Value

  • Normal

    200

  • Abnormal
    Table 4 Returned value description

    Returned Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the rights to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.