Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying DCS Instance Backup Records

Updated on 2024-03-05 GMT+08:00

Function

This API is used to query the backup records of a specified DCS instance.

URI

GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

instance_id

String

Yes

DCS instance ID.

start

Integer

No

Start sequence number of the backup record that is to be queried. By default, this parameter is set to 1.

limit

Integer

No

Number of backup records displayed on each page. The minimum value of this parameter is 1. If this parameter is not set, 10 backup records are displayed on each page by default.

beginTime

String

No

Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

endTime

String

No

End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

Request

Request parameters

None.

Example request

GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Parameter description

Parameter

Type

Description

backup_record_response

Array

Array of the backup records. For details about backup_record_response, see Table 3.

total_num

Integer

Number of obtained backup records.

Table 3 backup_record_response parameter description

Parameter

Type

Description

status

String

Backup status. Options:

  • waiting: DCS instance restoration is waiting to begin.
  • backuping: DCS instance backup is in progress.
  • succeed: DCS instance backup succeeded.
  • failed: DCS instance backup failed.
  • expired: The backup file expires.
  • deleted: The backup file has been deleted manually.

remark

String

Description of DCS instance backup

period

String

Time segment in which DCS instance backup was performed

progress

String

Backup progress

size

Long

Size of the backup file. Unit: byte.

instance_id

String

DCS instance ID

backup_id

String

ID of the backup record

created_at

String

Time at which the backup task is created

updated_at

String

Time at which DCS instance backup is completed

execution_at

String

Time at which the backup starts.

backup_type

String

Backup type. Options:

  • manual: manual backup
  • auto: automatic backup

backup_name

String

Name of the backup record

error_code

String

Error code returned if DCS instance backup fails. For details about error codes, see Table 4.

is_support_restore

String

An indicator of whether restoration is supported. Options: TRUE or FALSE.

Table 4 Error codes returned in case of a backup or restoration failure

Error Code

Description

dcs.08.0001

Failed to start the backup and restore tool.

dcs.08.0002

Operation timed out.

dcs.08.0003

Failed to delete bucket.

dcs.08.0004

Failed to obtain AK/SK.

dcs.08.0005

Failed to create bucket.

dcs.08.0006

Failed to obtain backup file size.

dcs.08.0007

Data synchronization failed during instance restoration.

dcs.08.0008

Automatic backup of the instance cannot start because the instance is running other jobs.

Example response

{
    "backup_record_response": [
        {
            "status": "succeed",
            "remark": "001",
            "period": null,
            "progress": "100.00",
            "size": 880232,
            "instance_id": "5560df16-cebf-4473-95c4-d1b573c16e79",
            "backup_id": "4631832a-14c6-45b0-a0b3-3abd8f591ad1",
            "created_at": "2019-05-10T08:31:16.166Z",
            "updated_at": "2019-05-10T08:32:30.546Z",
            "execution_at": "2019-05-10T08:31:21.461Z",
            "backup_type": "manual",
            "backup_name": "backup_20190510163116",
            "error_code": null,
            "is_support_restore": "TRUE"
        }
    ],
    "total_num": 1
}

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 5 Status code

Status Code

Description

200

DCS instance backup records queried successfully.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback