Querying Shared Backups

Function

This API is used to query shared backups.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about the request header parameters.

Authorization Information

Constraints

• This API is available for RDS for PostgreSQL only.
• To use this API, submit a service ticket.

URI

• URI format

  GET /v3/{project_id}/share-backups

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	No	String	Definition Instance ID. You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Constraints N/A Range N/A Default Value N/A
  instance_name	No	String	Definition Instance name. You can obtain the value of this parameter from name in Table 4 by calling the API for querying DB instances. Constraints N/A Range N/A Default Value N/A
  backup_name	No	String	Definition Backup name. You can obtain the value of this parameter from name in Table 3 by calling the API for obtaining backups. Constraints N/A Range N/A Default Value N/A
  offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range An integer greater than or equal to 0 Default Value The default value is 0, indicating that the query starts from the first data record.
  limit	No	Integer	Definition Number of records returned by a query. Constraints N/A Range [1, 100] Default Value 100

Request

None

Example Request

Query shared backups.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/share-backups?offset=1&limit=10

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  backups	Array of objects	Definition Backup list. For details, see Table 3.
  total	Long	Definition Total number of records. Range N/A

  Table 3 backups field description

  Parameter	Type	Description
  id	String	Definition Backup ID. Range N/A
  name	String	Definition Backup name. Range N/A
  begin_time	String	Definition Backup start time. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
  end_time	String	Definition Backup end time. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
  status	String	Definition Backup status. Range BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed DELETING: backup being deleted
  size	Double	Definition Backup size, in KB. Range N/A
  type	String	Definition Backup type. Range Snapshot: manual backup Db: automated backup Log: log backup OffSiteDb: cross-region automated backup OffSiteLog: cross-region log backup SnapshotDatabaseBackup: manual table-level backup
  backup_method	String	Definition Backup method. Range Physics: physical backup Snapshot: snapshot backup
  instance_id	String	Definition ID of the instance for which the backup is created. Range N/A
  instance_name	String	Definition Name of the instance for which the backup is created. Range N/A
  instance_status	String	Definition Status of the instance for which the backup is created. Range normal: The instance is normal. deleted: The instance has been deleted. shutdown: The instance is stopped. abnormal: The instance is abnormal. data_disk_full: The instance storage is full.
  datastore	Object	Definition Database version information. For details, see Table 4.
  user_name	String	Definition Name of the account that the backup is shared with. Range N/A

  Table 4 datastore field description

  Parameter	Type	Description
  type	String	Definition DB engine, which is case-insensitive. Range postgresql
  version	String	Definition Database version. Range N/A

• Example normal response

  {
      "backups": [
          {
              "id": "5f7e53404b544905ae5072bb9b99104fbr03",
              "name": "backup-303e",
              "begin_time": "2023-08-06T12:41:14+0800",
              "end_time": "2023-08-06T12:43:14+0800",
              "status": "COMPLETED",
              "size": 3668.963868,
              "type": "Snapshot",
              "backup_method": "Physics",
              "instance_id": "ff8d322bbeb144369459e95882941d7ain03",
              "instance_name": "rds-cc71",
              "instance_status": "deleted",
              "datastore": {
                  "type": "postgresql",
                  "version": "15.4.0"
              },
              "user_name": "cloud_3536"
          },
          {
              "id": "d2cc77f83a5c4ad2a7a73b493afbd20dbr03",
              "name": "backup-c918",
              "begin_time": "2023-08-06T12:41:14+0800",
              "end_time": "2023-08-06T12:43:14+0800",
              "status": "COMPLETED",
              "size": 3925.561524,
              "type": "Snapshot",
              "backup_method": "Physics",
              "instance_id": "56074f3b56bb4bbabbb73c8f0797d3fdin03",
              "instance_name": "rds-5f45",
              "instance_status": "deleted",
              "datastore": {
                  "type": "postgresql",
                  "version": "14.6.1"
              },
              "user_name": "cloud_3536"
          }
      ]
      "total": 2
  }

• Abnormal response

  For details, see Abnormal Response Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.