All Products
Search
Document Center

:DescribeSharedBackups

Last Updated:Jun 10, 2026

Mengkueri set cadangan bersama.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionId

string

No

ID wilayah.

Catatan

Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah yang tersedia.

cn-hangzhou

DBClusterId

string

No

ID kluster.

pc-**************

BackupId

string

No

ID set cadangan.

111111111

ShareType

string

Yes

Tipe berbagi. Nilai valid:

  • ShareIncoming: cadangan yang dibagikan kepada Anda.

  • ShareOutgoing: cadangan yang Anda bagikan.

ShareIncoming

PageSize

integer

No

Jumlah entri per halaman. Nilai valid: 30 hingga 100. Nilai default: 30.

30

PageNumber

integer

No

Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0. Nilai default: 1.

1

DBType

string

No

Tipe database. Nilai valid:

  • MySQL

  • PostgreSQL

  • Oracle

Untuk menentukan beberapa tipe, pisahkan dengan koma.

MySQL,PostgreSQL,Oracle

DBVersion

string

No

Versi database.

8.0

Elemen respons

Element

Type

Description

Example

object

The response object.

TotalRecordCount

string

The total record count.

16

PageRecordCount

string

The number of entries on the current page.

1

RequestId

string

The request ID.

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

PageNumber

string

The page number.

1

Items

array<object>

A list of shared backup sets.

object

The details of a shared backup set.

BackupSetSize

string

The size of the backup set, in bytes.

4639948800

ConsistentTime

string

The UNIX timestamp of the consistent snapshot, in seconds.

1589253947

BackupStatus

string

The backup status. Valid values:

  • Success: The backup is complete.

  • Failed: The backup failed.

Success

BackupType

string

The backup type. Only full backups are supported. The value is fixed to FullBackup.

FullBackup

BackupStartTime

string

The start time of the backup, in UTC.

2020-11-15T07:30:05Z

BackupEndTime

string

The end time of the backup, in UTC.

2020-05-12T03:25:55Z

BackupId

string

The backup set ID.

111111111

DBClusterId

string

The cluster ID.

pc-****************

BackupsLevel

string

The backup level. Valid values:

  • Level-1: Level-1 backup.

  • Level-2: Level-2 backup.

Level-2

BackupMode

string

The backup mode. Valid values:

  • Automated: automated backup

  • Manual: manual backup

Manual

BackupMethod

string

The backup method. Only snapshot backup is supported. The value is fixed to Snapshot.

Snapshot

DBType

string

The database engine type.

MySQL

DBVersion

string

The database engine version.

5.6

ShareType

string

The share type.

ShareIncoming

PayType

string

The billing method. Valid values:

  • Postpaid: pay-as-you-go.

  • Prepaid: prepaid (subscription)

Postpaid

ServerlessType

string

The Serverless type. A value of AgileServerless indicates a Serverless cluster, while an empty value indicates a standard cluster.

AgileServerless

RegionId

string

The region ID.

cn-hongzhou

SharerUID

string

The UID of the account that shared the backup set.

170*************

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": "16",
  "PageRecordCount": "1",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "PageNumber": "1",
  "Items": [
    {
      "BackupSetSize": "4639948800",
      "ConsistentTime": "1589253947",
      "BackupStatus": "Success",
      "BackupType": "FullBackup",
      "BackupStartTime": "2020-11-15T07:30:05Z",
      "BackupEndTime": "2020-05-12T03:25:55Z",
      "BackupId": "111111111",
      "DBClusterId": "pc-****************",
      "BackupsLevel": "Level-2",
      "BackupMode": "Manual",
      "BackupMethod": "Snapshot",
      "DBType": "MySQL",
      "DBVersion": "5.6",
      "ShareType": "ShareIncoming",
      "PayType": "Postpaid",
      "ServerlessType": "AgileServerless",
      "RegionId": "cn-hongzhou",
      "SharerUID": "170*************"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.