Ringkasan API snapshot backup Tablestore - Cloud Backup - Alibaba Cloud - Cloud Backup

Mengkueri detail instans Tablestore yang dicadangkan.

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

hbr:DescribeOtsTableSnapshots

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
StartTime	integer	No	Pengatur waktu mulai pencadangan. Nilai harus berupa Stempel waktu UNIX. Unit: milliseconds.	1611109271630
EndTime	integer	No	Pengatur waktu selesai pencadangan. Nilai harus berupa Stempel waktu UNIX. Unit: milliseconds.	1652068250881
SnapshotIds	array	No	ID snapshot.
	string	No	The snapshot ID.	s-00047mxg17p26****3c
OtsInstances	array<object>	No	Instans Tablestore yang dicadangkan.
	object	No	The list of Tablestore instances that are backed up.
InstanceName	string	No	The name of the Tablestore instance.	instancename
TableNames	array	No	The names of the tables in the Tablestore instance.
	string	No	The name of the table in the Tablestore instance.	tablename
Limit	integer	No	Jumlah maksimum baris yang ingin dikembalikan oleh kueri saat ini.	100
NextToken	string	No	Token yang diperlukan untuk mendapatkan halaman berikutnya dari Snapshot cadangan.	caeba0bbb2be03f84eb48b699f0a****
CrossAccountType	string	No	Apakah akan mencadangkan data dalam satu akun Alibaba Cloud yang sama atau lintas akun Alibaba Cloud. Nilai valid: SELF_ACCOUNT: Data dicadangkan dalam satu akun Alibaba Cloud yang sama. CROSS_ACCOUNT: Data dicadangkan lintas akun Alibaba Cloud.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	UID akun sumber yang digunakan untuk pencadangan lintas akun.	144015xxxxx98732
CrossAccountRoleName	string	No	Nama Peran RAM yang dibuat dalam akun sumber Alibaba Cloud dan ditetapkan ke akun Alibaba Cloud saat ini untuk mengizinkan akun Alibaba Cloud saat ini mencadangkan data lintas akun Alibaba Cloud.	BackupRole

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	09376812-6290-5E36-B504-E8010D72D1F0
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
Limit	integer	The number of backup snapshots that are displayed on the current page.	10
Snapshots	array<object>	The backup snapshots.
	object
Status	string	The status of the backup job. Valid values: COMPLETE: The backup job is completed. PARTIAL_COMPLETE: The backup job is partially completed. FAILED: The backup job has failed.	COMPLETE
SnapshotHash	string	The hash value of the backup snapshot.	f2fe...
VaultId	string	The ID of the backup vault that stores the backup snapshot.	v-00030j*******sn
BackupType	string	The backup type. Valid value: COMPLETE, which indicates full backup.	COMPLETE
CreateTime	integer	The time when the Tablestore instance was created. The value is a UNIX timestamp. Unit: seconds.	1607436917
ActualBytes	string	The actual data amount of backup snapshots after duplicates are removed. Unit: bytes.	0
SourceType	string	The type of the data source. Valid values: ECS_FILE: backup snapshots for Elastic Compute Service (ECS) files OSS: backup snapshots for Object Storage Service (OSS) buckets NAS: backup snapshots for Apsara File Storage NAS file systems OTS_TABLE: backup snapshots for Tablestore instances	OTS_TABLE
BytesTotal	integer	The total amount of data. Unit: bytes.	0
CompleteTime	integer	The time when the backup snapshot was completed. The value is a UNIX timestamp. Unit: seconds.	1642496679
Retention	integer	The retention period of the backup snapshot. Unit: days.	730
CreatedTime	integer	The time when the backup snapshot was created. The value is a UNIX timestamp. Unit: seconds.	1642496679
ParentSnapshotHash	string	The hash value of the parent backup snapshot.	f2fe..
StartTime	integer	The time when the backup snapshot started. The value is a UNIX timestamp. Unit: seconds.	1642496543
UpdatedTime	integer	The time when the backup snapshot was updated. The value is a UNIX timestamp. Unit: seconds.	1642496679
SnapshotId	string	The ID of the backup snapshot.	s-00047mxg17p26*****b
JobId	string	The ID of the backup job.	job-00030j3chkt******2
InstanceName	string	The name of the Tablestore instance.	instancename
TableName	string	The name of the table in the Tablestore instance.	table2
RangeStart	integer	The time when the backup job started. The value is a UNIX timestamp. Unit: milliseconds.	1642492553038
RangeEnd	integer	The time when the backup job ended. The value is a UNIX timestamp. Unit: milliseconds.	1642521709966
NextToken	string	The token that is required to obtain the next page of backup snapshots.	caeba0bbb2be03f84eb48b699f0a

Contoh

Respons sukses

JSONformat

{
  "RequestId": "09376812-6290-5E36-B504-E8010D72D1F0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Limit": 10,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2fe...",
      "VaultId": "v-00030j*******sn",
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": "0",
      "SourceType": "OTS_TABLE",
      "BytesTotal": 0,
      "CompleteTime": 1642496679,
      "Retention": 730,
      "CreatedTime": 1642496679,
      "ParentSnapshotHash": "f2fe..",
      "StartTime": 1642496543,
      "UpdatedTime": 1642496679,
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.