|
API Explorer
Operation
Middleware
CodeArts
Networking
Content Delivery & Edge Computing
Compute
Security & Compliance
Databases
AI
Analytics
Containers
Migration
Management & Governance
Business Applications
Storage
Developer Tools
Media Services
Internet of Things
Operation
Middleware
CodeArts
Networking
Content Delivery & Edge Computing
Compute
Security & Compliance
Databases
AI
Analytics
Containers
Migration
Management & Governance
Business Applications
Storage
Developer Tools
Media Services
Internet of Things
My Favorites

You are not logged in.

My Collections
More
English
Data Warehouse Service
| Details
  • Cluster Management APIs
    • ChangeSecurityGroup
    • CreateCluster
    • DeleteCluster
    • DeleteDwsCluster
    • ListClusterDetails
    • ListClusters
    • ListNodeTypes
    • ResetPassword
    • ResizeCluster
    • RestartCluster
    • ShowClusterFlavor
    • ShowClusters
  • Snapshot Management APIs
    • CreateSnapshot
    • DeleteSnapshot
    • ListSnapshotDetails
    • ListSnapshots
    • RestoreCluster
  • Audit logs
    • DisableLtsLogs
    • EnableLtsLogs
    • ListLtsLogs
  • Cluster Management
    • ListConfigurationsAuditRecords
    • SaveClusterDescriptionInfo
    • ShowClusterRedistribution
    • ShowInstance
  • Host Monitoring
    • ListQueries
    • ListTablesStatistic
    • ShowQueryDetail
  • Resource Management
    • DeleteWorkloadPlan
    • ShowWorkloadPlan
    • StartWorkloadPlan
    • StopWorkloadPlan
  • Snapshot Management
    • AddSnapshotCrossRegionPolicy
    • DeleteSnapshotCrossRegionPolicy
    • ListSnapshotCrossRegion
    • ListSnapshotCrossRegionPolicy
    • RestoreTable
  • Upgrade Management
    • ExecuteClusterUpgradeAction
    • ListUpdatableVersion
    • ListUpdateRecord

RestoreCluster

POST
https://dws.af-north-1.myhuaweicloud.com/v1.0/{project_id}/snapshots/{snapshot_id}/actions
Advanced
Required parameters only
Default
Encrypt sensitive parameters
*
Region
Parameters
*
project_id
*
snapshot_id
Body
*{
*
restore
: {
*
name
:
*
subnet_id
:
*
security_group_id
:
*
vpc_id
:
*
availability_zone
:
*
port
:
*
public_ip
: {
*
public_bind_type
:
*
eip_id
:
*}
*
enterprise_project_id
:
*
ipv6_enable
:
*}
}
API Description

This API is used to restore clusters using the snapshot.

URL
POST  https://dws.af-north-1.myhuaweicloud.com/v1.0/{project_id}/snapshots/{snapshot_id}/actions
Request Parameters
NameTypeINMandatoryDescription
snapshot_id
stringpath Yes

ID of the snapshot to be restored

project_id
stringpath Yes

Project ID

Body Parameters
NameTypeMandatoryDescription
restore
Restore object Yes

Object to be restored

Parameter:
restore
NameTypeMandatoryDescription
name
string Yes

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

subnet_id
string No

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

security_group_id
string No

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

vpc_id
string No

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

availability_zone
string No

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

port
integer No

Service port of a cluster. The value ranges from 8000 to 30000.

public_ip
PublicIp object No

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

enterprise_project_id
string No

Enterprise project. The default enterprise project ID is 0.

ipv6_enable
boolean No

Specifies the network protocol type, indicating whether IPv6 is supported. By default, IPv6 is not used.

Parameter:
restore.public_ip
NameTypeMandatoryDescription
public_bind_type
string No

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

  • auto_assign
  • not_use
  • bind_existing
eip_id
string No

EIP ID

Response Parameters
Status code: 200

Normal

NameTypeDescription
cluster
Cluster object

Cluster object

200 cluster
NameTypeDescription
id
string

Cluster ID

Status code: 400

Request error.

Status code: 401

Authorization failed.

Status code: 403

No operation permission.

Status code: 404

No resources found.

Status code: 500

Internal service error.

Status code: 503

The service is unavailable.

Example Request
Example 1
"POST https://{Endpoint}/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": "az1.dc1",
        "port": 8000,
        "public_ip": {
            "public_bind_type": "auto_assign",
            "eip_id": ""
        },
        "enterprise_project_id": "aca4e50a-266f-4786-827c-f8d6cc3fbada"
    }
}
Example Response
Status code: 200

Normal

Example 1
{
  "cluster": {
    "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
  }
}
SDK
Click Data Warehouse Service (DWS) SDK to download the SDK in your programming language or view the SDK documentation. To learn how to install an SDK and perform authentication, read Usage.
Error Code

Outline

API Description
URL
Request Parameters
Response Parameters
Example Request
Example Response
SDK
Error Code