|
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
Customer Operation Capabilities
Middleware
Distributed Cache Service
Distributed Message Service for Kafka
Cloud Service Engines
Distributed Message Service for RocketMQ
Distributed Message Service for RabbitMQ
API Gateway
CodeArts
Cloud Performance Test Service
ServiceStage
CodeCheck
CodeArts Req
CodeHub
CloudBuild
CloudTest
CodeArts Deploy
CodeArts Check
CodeArts Pipeline
CodeArts Build
CodeArts Artifact
Networking
Elastic Load Balance
Virtual Private Cloud
Elastic IP
NAT Gateway
VPC Endpoint
Cloud Connect
Enterprise Router
Global Accelerator
Direct Connect
Virtual Private Network
Content Delivery & Edge Computing
Content Delivery NetWork
Compute
Elastic Cloud Server
Auto Scaling
FunctionGraph
Image Management Service
Bare Metal Server
Security & Compliance
Host Security Service
Data Encryption Workshop KPS
Cloud Secret Management Service
Data Encryption Workshop KMS
Cloud Certificate Manager Service
SSL Certificate Manager
Anti-DDoS
Database Security Service
Web Application Firewall
Data Security Center
Cloud Firewall
Cloud Bastion Host
Edge Security
SecMaster
Advanced Anti-DDoS
Databases
Document Database Service
Relational Database Service
TaurusDB
GaussDB
GeminiDB
Data Replication Service
Database and Application Migration UGO
Distributed Database Middleware
Data Admin Service (DAS)
AI
Optical Character Recognition
Face Recognition Service
ModelArts
Image
ImageSearch
Moderation
Speech Interaction Service
Graph Engine Service
Question Answering Bot
Analytics
MapReduce Service
Data Warehouse Service
Data Lake Insight
DataArts Studio
Cloud Search Service
Date Ingestion Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Orchestration Service
Cloud Container Instance
Migration
Server Migration Service
Object Storage Migration Service
CloudDataMigration
Management & Governance
Identity and Access Management
Cloud Eye
Log Tank Service
Resource Management Service
Cloud Trace Service
Tag Management Service
Enterprise Project Management Service
Simple Message Notification
Application Operations Management
Organizations
Resource Access Manager
Config
IAMAccessAnalyzer
IAM Identity Center
IAM Identity Center Store
IAM Identity Center SCIM
IAM Identity Center OIDC
Security Token Service
Cloud Operations Center
Resource Governance Center
Business Applications
ROMA
Domain Name Service
HUAWEI CLOUD Meeting
Workspace
Storage
Elastic Volume Service
Cloud Backup and Recovery
SFSTurbo
Object Storage Service
Developer Tools
APIExplorer
Media Services
Media Processing Center
Live
Video On Demand
Huawei Cloud Real-Time Communication
Internet of Things
IoT Device Access
IoT Device Access Management
My Favorites
You are not logged in.
My Collections
More
English
Overview
Change History
Debugging History
All Products
All Products
Recently viewed: Data Warehouse Service
Product Type
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
Customer Operation Capabilities
Middleware
Distributed Cache Service
Distributed Message Service for Kafka
Cloud Service Engines
Distributed Message Service for RocketMQ
Distributed Message Service for RabbitMQ
API Gateway
CodeArts
Cloud Performance Test Service
ServiceStage
CodeCheck
CodeArts Req
CodeHub
CloudBuild
CloudTest
CodeArts Deploy
CodeArts Check
CodeArts Pipeline
CodeArts Build
CodeArts Artifact
Networking
Elastic Load Balance
Virtual Private Cloud
Elastic IP
NAT Gateway
VPC Endpoint
Cloud Connect
Enterprise Router
Global Accelerator
Direct Connect
Virtual Private Network
Content Delivery & Edge Computing
Content Delivery NetWork
Compute
Elastic Cloud Server
Auto Scaling
FunctionGraph
Image Management Service
Bare Metal Server
Security & Compliance
Host Security Service
Data Encryption Workshop KPS
Cloud Secret Management Service
Data Encryption Workshop KMS
Cloud Certificate Manager Service
SSL Certificate Manager
Anti-DDoS
Database Security Service
Web Application Firewall
Data Security Center
Cloud Firewall
Cloud Bastion Host
Edge Security
SecMaster
Advanced Anti-DDoS
Databases
Document Database Service
Relational Database Service
TaurusDB
GaussDB
GeminiDB
Data Replication Service
Database and Application Migration UGO
Distributed Database Middleware
Data Admin Service (DAS)
AI
Optical Character Recognition
Face Recognition Service
ModelArts
Image
ImageSearch
Moderation
Speech Interaction Service
Graph Engine Service
Question Answering Bot
Analytics
MapReduce Service
Data Warehouse Service
Data Lake Insight
DataArts Studio
Cloud Search Service
Date Ingestion Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Orchestration Service
Cloud Container Instance
Migration
Server Migration Service
Object Storage Migration Service
CloudDataMigration
Management & Governance
Identity and Access Management
Cloud Eye
Log Tank Service
Resource Management Service
Cloud Trace Service
Tag Management Service
Enterprise Project Management Service
Simple Message Notification
Application Operations Management
Organizations
Resource Access Manager
Config
IAMAccessAnalyzer
IAM Identity Center
IAM Identity Center Store
IAM Identity Center SCIM
IAM Identity Center OIDC
Security Token Service
Cloud Operations Center
Resource Governance Center
Business Applications
ROMA
Domain Name Service
HUAWEI CLOUD Meeting
Workspace
Storage
Elastic Volume Service
Cloud Backup and Recovery
SFSTurbo
Object Storage Service
Developer Tools
APIExplorer
Media Services
Media Processing Center
Live
Video On Demand
Huawei Cloud Real-Time Communication
Internet of Things
IoT Device Access
IoT Device Access Management
My Products
Data Warehouse Service
- 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
ListSnapshotDetails
GET
https://dws.af-north-1.myhuaweicloud.com/v1.0/{project_id}/snapshots/{snapshot_id}
Advanced
Required parameters only
Default
Encrypt sensitive parameters
*
Region
- AF-Cairo
- AF-Johannesburg
- AP-Bangkok
- AP-Jakarta
- AP-Kuala Lumpur-OP6
- AP-Singapore
- CN East-Qingdao
- CN East-Shanghai1
- CN East-Shanghai2
- CN North-Beijing1
- CN North-Beijing2
- CN North-Beijing4
- CN North-Ulanqab1
- CN South-Guangzhou
- CN Southwest-Guiyang1
- CN-Hong Kong
- LA-Mexico City1
- LA-Mexico City2
- LA-Santiago
- LA-Sao Paulo1
- ME-Abu Dhabi-OP5
- TR-Istanbul
- ru-moscow-1
Parameters
*
project_id
*
snapshot_id
API Description
This API is used to query snapshot details by using the snapshot ID.
URL
GET https://dws.af-north-1.myhuaweicloud.com/v1.0/{project_id}/snapshots/{snapshot_id}
Request Parameters
| Name | Type | IN | Mandatory | Description |
|---|---|---|---|---|
snapshot_id | string | path | Yes | Snapshot ID |
project_id | string | path | Yes | Project ID |
Response Parameters
Status code: 200
Normal
| Name | Type | Description |
|---|---|---|
snapshot | SnapshotDetail object | Snapshot object |
200 snapshot
| Name | Type | Description |
|---|---|---|
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:
|
type | string | Snapshot type |
cluster_id | string | ID of the cluster for which snapshots are created |
datastore | Datastore object | Database version |
cluster_name | string | Name of the cluster for which the snapshot is created |
bak_expected_start_time | string | Estimated snapshot start time |
bak_keep_day | integer | Backup retention days |
bak_period | string | Cluster policy |
db_user | string | Backup user |
progress | string | Backup progress |
backup_key | string | Key generated during backup. |
prior_backup_key | string | Backup key of the previous snapshot used by the incremental backup The value FULL indicates a full snapshot. |
base_backup_key | string | Backup key of a full snapshot |
backup_device | string | Backup media |
total_backup_size | integer | Accumulated size of a snapshot, from the full backup to the incremental backup. |
base_backup_name | string | Name of a full snapshot |
support_inplace_restore | boolean | Whether data can be restored to the original cluster |
fine_grained_backup | boolean | Whether the backup is a fine-grained backup |
backup_level | string | Backup level |
fine_grained_backup_detail | FineGrainedSnapshotDetail object | Fine-grained backup information |
guest_agent_version | string | GuestAgent version |
cluster_status | string | Cluster status |
200 snapshot.datastore
| Name | Type | Description |
|---|---|---|
type | string | Database type |
version | string | Database version |
200 snapshot.fine_grained_backup_detail
| Name | Type | Description |
|---|---|---|
database | string | Database backup |
schema_list | Array of strings | Backup schema set |
table_list | Array of strings | Backup table set |
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/b5c45780-1006-49e3-b2d5-b3229975bbc7"Example Response
Status code: 200
Normal
Example 1
"snapshot": {
"id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name": "snapshot-1",
"description": "snapshot 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"
}
}
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