Updated on 2025-09-19 GMT+08:00

API Overview

DWS provides Huawei-developed APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.

Table 1 APIs

Function

API

Description

Cluster management

Performing a Check Before Cluster Creation

Performs a check before cluster creation.

Creating a Cluster

Creates a cluster.

Querying the List of Clusters

Queries and displays the cluster list.

Querying Cluster Details

Queries cluster details.

Querying Flavors

Queries all node types supported by DWS.

Deleting a Cluster

Deletes a cluster.

Restarting a Cluster

Restarts a cluster.

Scaling Out a Cluster

Scales out a cluster.

Resetting a Password

Resets the cluster administrator password.

Querying the List of DSS Storage Pools

Queries DSS storage pools available to a tenant.

Querying a Cluster Parameter Template

Queries the parameter group associated with a cluster.

Canceling the Read-Only Status

Cancels the read-only status on the management console.

Querying CNs in a Cluster

Queries information about CNs in a specified cluster.

Adding CN Nodes in Batches

Adds CNs in batches to a specified cluster.

Deleting CN Nodes in Batches

Deletes CNs from a specified cluster.

Scaling In a Cluster

Scales in a cluster.

Snapshot management

Creating a Snapshot

Creates snapshots for a specified cluster.

Querying the Cluster Snapshot List

Queries the snapshot list.

Querying Snapshot Details

Queries the snapshot details using the snapshot ID.

Deleting a Snapshot

Deletes a snapshot.

Deleting a Snapshot Policy

Deletes a snapshot policy.

Restoring a Cluster

Restores a cluster using a snapshot.

Copying a Snapshot

Replicates an automated snapshot.

Adding a Snapshot Policy

Sets a snapshot policy.

Incident management

Querying the Event List

Queries the event list.

Querying Subscribed Events

Queries subscribed events.

Creating an Event Subscription

Adds a subscribed event.

Updating an Event Subscription

Updates a subscribed event.

Deleting an Event Subscription

Deletes a subscribed event.

Data source

Querying Data Sources

Queries data sources.

Editing a Data Source

Updates a data source.

Audit logs

Querying Logs

Queries audit logs.

Alarm management

Querying the Alarm Details List

Queries the alarm details list.

Querying the Alarm Statistics List

Queries alarm statistics.

Querying the Alarm Subscription List

Queries subscribed alarms.

Creating an Alarm Subscription

Creates an alarm subscription.

Editing an Alarm Subscription

Updates a subscribed alarm.

Deleting an Alarm Subscription

Deletes a subscribed alarm.

AZ

Querying the AZ List

Queries the AZs available for a tenant to create a cluster.

Connection management

Applying for a Domain Name

Applies for a domain name for a specified cluster.

Modifying a Cluster Domain Name

Changes the domain name of a specified cluster.

Deleting a Cluster Domain Name

Deletes the domain name of a specified cluster.

Obtaining the List of ELBs That Can Be Bound to a Cluster

Queries the list of ELBs that can be associated with a cluster.

Binding an ELB to a Cluster

Binds an ELB to a cluster.

Unbinding an ELB from a Cluster

Unbinds an ELB from a cluster.

Binding an EIP to a Cluster

Binds an EIP to a cluster.

Unbinding an EIP from a Cluster

Unbound an EIP from a cluster.

Tag management

Querying Project Tags

Queries project tags.

Querying Cluster Tags

Queries tags of a specified cluster.

Adding Tags in Batches

Batch adds tags to a specified cluster.

Deleting Tags in Batches

Batch deletes tags from a specified cluster.

Quota management

Querying Quotas

Queries the DWS quota of a tenant.