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 Backups (Recommended)

Updated on 2024-12-31 GMT+08:00

Function

This API is used to query backups based on specified conditions.

URI

GET https://{Endpoint}/v3.1/{project_id}/backups

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

instance_id

No

String

Explanation:

Instance ID

Constraints:

You can call the API used for querying instances to obtain the value. If there are no instances available, create one by calling the API used for creating an instance.

Values:

N/A

Default value:

N/A

datastore_type

No

String

Explanation:

Database type

Constraints:

N/A

Values:

  • cassandra
  • redis
  • mongodb
  • influxdb

Default value:

N/A

backup_id

No

String

Explanation:

Backup ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

backup_type

No

String

Explanation:

Backup type

Constraints:

The value is case sensitive.

Values:

  • Auto, indicating that this backup is an automatic full backup.
  • Manual, indicating that this backup is a manual full backup.

Default value:

If this parameter is not transferred, all automated and manual full backups (including database- and table-level backups) are queried by default.

type

No

String

Explanation:

Backup policy type

Constraints:

N/A

Values:

  • Instance, indicating that an instance backup is queried.
  • DatabaseTable, indicating that a database or table backup is queried.

Default value:

Instance

limit

No

Integer

Explanation:

Maximum backup records to be queried.

Constraints:

N/A

Values:

1 to 100

Default value:

If this parameter is not transferred, the first 100 instances are queried by default.

offset

No

Integer

Explanation:

Index position. The query starts from the next backup creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.

Constraints:

N/A

Values:

The value must be greater than or equal to 0.

Default value:

If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

begin_time

No

String

Explanation:

Time when a backup query starts

Constraints:

When end_time is not empty, begin_time is mandatory.

Values:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

Default value:

Null

end_time

No

String

Explanation:

Time when a backup query ends

Constraints:

When begin_time is not empty, end_time is mandatory.

Values:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

Default value:

Null

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Explanation:

Total backups.

Values:

N/A

backups

Array of objects

Explanation:

Backup details. For details, see Table 5.

Table 5 Backup

Parameter

Type

Description

id

String

Explanation:

Backup ID.

Values:

N/A

description

String

Explanation:

Backup description.

Values:

N/A

instance_id

String

Explanation:

ID of the instance that the backup is created for.

Values:

N/A

instance_name

String

Explanation:

Name of the instance that the backup is created for.

Values:

N/A

datastore

object

Explanation:

DB version information. For details, see Table 6.

name

String

Explanation:

Backup name.

Values:

N/A

type

String

Explanation:

Backup type

Values:

  • Auto: indicates that this backup is an automatic full backup.
  • Manual: indicates that this backup is a manual full backup.

size

Double

Explanation:

Backup size, in KB.

Values:

N/A

status

String

Explanation:

Backup status

Values:

  • BUILDING, indicating that the backup is in progress.
  • COMPLETED, indicating that the backup is completed.
  • FAILED, indicating that the backup failed.

begin_time

String

Explanation:

Backup start time

Constraints:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

end_time

String

Explanation:

Backup end time

Constraints:

The value is in the format of yyyy-mm-ddThh:mm:ssZ. T indicates start time and Z a time zone offset.

database_tables

Array of objects

Explanation:

Database and table information in the backup. For details, see Table 7.

Constraints:

  • Keep this parameter empty or ignore it when you query an instance backup.
  • Specify this parameter when you query a database or table backup (if any).
Table 6 Datastore

Parameter

Type

Description

type

String

Explanation:

Database type

Values:

N/A

version

String

Explanation:

Database version

Values:

N/A

Table 7 QueryDatabaseTableInfo

Parameter

Type

Description

database_name

String

Explanation:

Database name.

Values:

N/A

table_names

Array of strings

Explanation:

Table names.

  • If this parameter is empty, database names are queried.
  • If this parameter is not empty, table names are queried.

Example Requests

  • URI example
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/
    054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2019-05-27T03:38:51+0000&end_time=2019-05-28T03:38:51+0000&type=DatabaseTable
  • Example request body

    None

Example Responses

Status code: 200

Success

{ 
  "total_count" : 4, 
  "backups" : [ { 
    "id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
    "name" : "backup-test", 
    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
    "instance_name" : "cluster-test", 
    "datastore" : { 
      "type" : "cassandra", 
      "version" : "3.4" 
    }, 
    "type" : "Auto", 
    "begin_time" : "2019-05-27T03:38:51+0000", 
    "end_time" : "2019-05-27T03:39:51+0000", 
    "status" : "COMPLETED", 
    "size" : 2803, 
    "description" : "backup description", 
    "database_tables" : [ { 
      "database_name" : "DATABASE_X", 
      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
    }, { 
      "database_name" : "DATABASE_Y", 
      "table_names" : null 
    } ] 
  }, { 
    "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
    "name" : "backup-test-2", 
    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
    "instance_name" : "cluster-test", 
    "datastore" : { 
      "type" : "cassandra", 
      "version" : "3.4" 
    }, 
    "type" : "Manual", 
    "begin_time" : "2019-05-27T03:38:51+0000", 
    "end_time" : "2019-05-27T03:39:51+0000", 
    "status" : "COMPLETED", 
    "size" : 2803, 
    "description" : "backup description", 
    "database_tables" : [ { 
      "database_name" : "DATABASE_X", 
      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
    }, { 
      "database_name" : "DATABASE_Y", 
      "table_names" : null 
    } ] 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

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