• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v1
  5. Backup and Restoration
  6. Returning Manual Backup Information as a List

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/{versionId}/{project_id}/backups

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

    Specifies the API version. It is case-sensitive and the value is v1.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

Request

N/A

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 DB instance ID.

    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.