Returning Manual Backup Information as a List

Function

This API is used to return manual backup information as a list.

URI

• URI format

  PATH: /rds/v1/{project_id}/backups

  Method: GET

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.

Request

None

Normal Response

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  backups	List data structure. For details, see Table 3.	Indicates the backup information.

  Table 3 backups field data structure description

  Name	Type	Description
  id	String	Indicates the backup ID.
  name	String	Indicates the backup file name.
  description	String	Indicates the backup description.
  locationRef	String	This is a reserved string and has no meanings.
  created	String	Indicates the backup creation time.
  updated	String	Indicates the completion time.
  size	Double	Indicates the file size in GB.
  status	String	Indicates the backup status. Its value can be BUILDING, COMPLETED, FAILED, or DELETING.
  backuptype	String	The default value is 1, indicating a manual backup.
  dataStore	Dictionary data structure. For details, see Table 4.	Indicates the database version.
  instance_id	String	Indicates the primary node ID of the DB instance. Note This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.
  parent_id	String	This is a reserved string and has no meanings.

  Table 4 dataStore field data structure description

  Name	Type	Description
  type	String	Indicates the DB engine. Valid value: MySQL PostgreSQL SQLServer
  version	String	Indicates the database version. For example, 5.6.30.
  version_id	String	Indicates the database version ID. Its value is unique.

• Response example

  {
    "backups" : [ {
      "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
      "name" : "50deafb3e45d451a9406ca146b71fe9a_rds-1_4f87d3c4-9e33-482f-b962-e23b30d1a18c_2016_08_23_01_59_23.tar.gz",
      "description" : "",
      "locationRef" : "",
      "created" : "2016-08-23T03:59:23",
      "updated" : "2016-08-23T04:01:40",
      "size" : 0.0,
      "status" : "COMPLETED",
      "backuptype" : "1",
      "dataStore" : {
        "type" : "MySQL",
        "version" : "5.6.30",
        "version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
      },
      "instance_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c",
      "parent_id" : null
    }, {
      "id" : "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
      "name" : "50deafb3e45d451a9406ca146b71fe9a_rds-lichao-1_4f87d3c4-9e33-482f-b962-e23b30d1a18c_2016_08_23_16_20_00.tar.gz",
      "description" : "",
      "locationRef" : "",
      "created" : "2016-08-23T18:20:00",
      "updated" : "2016-08-23T18:22:12",
      "size" : 3.73E-4,
      "status" : "COMPLETED",
      "backuptype" : "1",
      "dataStore" : {
        "type" : "MySQL",
        "version" : "5.6.30",
        "version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
      },
      "instance_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c",
      "parent_id" : null
    }
   ]
  }
  

Abnormal Response

For details, see Abnormal Request Results.

last updated: 2024-12-10 14:46 UTC - commit: 9f9e55bdbf80b2811cafe84f5e4810cce997be14