DescribeBackupTasks - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Mengkueri status eksekusi tugas cadangan instans Database Apsara for Tair (kompatibel dengan Redis).

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeBackupTasks

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans. Anda dapat memanggil operasi DescribeInstances untuk mengkueri ID instans.	r-bp1zxszhcgatnx****
BackupJobId	string	No	ID tugas cadangan. Catatan Jika Anda telah memanggil operasi CreateBackup untuk melakukan cadangan manual, Anda dapat meneruskan ID cadangan yang dikembalikan untuk mengkueri progres cadangan.	1162****
JobMode	string	No	Mode cadangan. Nilai valid: Automated: Sistem melakukan cadangan secara otomatis. Anda dapat memanggil operasi DescribeBackupPolicy untuk mengkueri kebijakan cadangan otomatis. Manual: Cadangan dilakukan secara manual. Catatan Secara default, informasi tugas dari semua mode cadangan dikembalikan.	Manual

Elemen respons

Element	Type	Description	Example
	object
InstanceId	string	ID instans.	r-bp1zxszhcgatnx****
RequestId	string	ID permintaan.	BB73740C-23E2-4392-9DA4-2660C74C****
BackupJobs	array<object>	Detail tugas cadangan.
	object
StartTime	string	Waktu ketika tugas cadangan dimulai. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ (waktu UTC).	2021-01-05T19:24:00Z
Process	string	Persentase progres tugas cadangan (tidak direkomendasikan; lihat parameter Progress).	0
JobMode	string	Mode cadangan. Nilai valid: Automated: Sistem melakukan cadangan secara otomatis. Manual: Cadangan dilakukan secara manual.	Manual
BackupJobID	integer	ID tugas cadangan.	29****10
BackupProgressStatus	string	Status tugas cadangan. Nilai valid: NoStart: Tugas cadangan belum dimulai. Preparing: Tugas cadangan sedang disiapkan. Waiting: Tugas cadangan sedang menunggu. Uploading: Tugas cadangan sedang diunggah. Checking: Tugas cadangan sedang diperiksa. Finished: Tugas cadangan telah selesai.	NoStart
NodeId	string	ID node data.	****
TaskAction	string	Tipe tugas cadangan. Nilai valid: TempBackupTask: tugas cadangan sementara, yaitu cadangan manual. NormalBackupTask: tugas cadangan normal, yaitu cadangan otomatis.	NormalBackupTask
Progress	string	Persentase progres cadangan. Nilai valid: 0 hingga 100.	27
AccessDeniedDetail	object	Kumpulan parameter ini tidak digunakan lagi. Abaikan.
AuthAction	string	Sama seperti di atas.	-
AuthPrincipalDisplayName	string	Sama seperti di atas.	-
AuthPrincipalOwnerId	string	Sama seperti di atas.	-
AuthPrincipalType	string	Sama seperti di atas.	-
EncodedDiagnosticMessage	string	Sama seperti di atas.	-
NoPermissionType	string	Sama seperti di atas.	-
PolicyType	string	Sama seperti di atas.	-

Contoh

Respons sukses

JSONformat

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
  "BackupJobs": [
    {
      "StartTime": "2021-01-05T19:24:00Z",
      "Process": "0",
      "JobMode": "Manual",
      "BackupJobID": 0,
      "BackupProgressStatus": "NoStart",
      "NodeId": "****",
      "TaskAction": "NormalBackupTask",
      "Progress": "27"
    }
  ],
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.