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

ListSnapshots

GET
https://dws.af-north-1.myhuaweicloud.com/v1.0/{project_id}/snapshots
Advanced
Required parameters only
Default
Encrypt sensitive parameters
*
Region
Parameters
*
project_id
API Description

This API is used to query the snapshot list.

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

Project ID

Response Parameters
Status code: 200

Normal

NameTypeDescription
snapshots
Array of Snapshots objects

List of snapshot objects

count
integer

Total number of snapshot objects

200 snapshots
NameTypeDescription
id
string

Snapshot ID

name
string

Snapshot name

description
string

Snapshot description

started
string

Time when a snapshot starts to be created.Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

finished
string

Time when a snapshot is complete. Format:ISO8601: YYYY-MM-DDThh:mm:ssZ

size
double

Snapshot size, in GB

status
string

Snapshot status:

  • CREATING
  • AVAILABLE
  • UNAVAILABLE
type
string

Snapshot type

cluster_id
string

ID of the cluster for which snapshots are created

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
"GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots"
Example Response
Status code: 200

Normal

Example 1
{
"snapshots": [
{
"id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name": "snapshot-1",
"description": "",
"started": "2016-08-23T03:59:23Z",
"finished": "2016-08-23T04:01:40Z",
"size": 500,
"status": "AVAILABLE",
"type": "MANUAL",
"cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
},
{
"id": "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
"name": "snapshot-2",
"description": "",
"started": "2016-08-23T18:20:00Z",
"finished": "2016-08-23T18:22:12Z",
"size": "500,",
"status": "AVAILABLE",
"type": "MANUAL",
"cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
}
],
"count": 2
}
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