Tablestore Backup Snapshots API Overview - Cloud Backup - Alibaba Cloud - Cloud Backup

Queries backup details of Tablestore instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:DescribeOtsTableSnapshots

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	No	The start time of the backup. The value must be a UNIX timestamp. Unit: milliseconds.	1611109271630
EndTime	integer	No	The end time of the backup. The value must be a UNIX timestamp. Unit: milliseconds.	1652068250881
SnapshotIds	array	No	The snapshot IDs.
	string	No	The snapshot ID.	s-00047mxg17p26****3c
OtsInstances	array<object>	No	The Tablestore instances that are backed up.
	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	The maximum number of rows to return.	100
NextToken	string	No	The token for retrieving the next page of backup snapshots.	caeba0bbb2be03f84eb48b699f0a****
CrossAccountType	string	No	The cross-account backup type. Valid values: SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	The UID of the source account used for cross-account backup.	144015xxxxx98732
CrossAccountRoleName	string	No	The name of the RAM role created within the source Alibaba Cloud account and assigned to the current account for cross-account backup.	BackupRole

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	09376812-6290-5E36-B504-E8010D72D1F0
Success	boolean	Whether the request was successful. Valid values: true false	true
Code	string	The HTTP status code. Status code 200 indicates success.	200
Message	string	The returned message. Returns "successful" on success, or an error message on failure.	successful
Limit	integer	The number of backup snapshots returned on the current page.	10
Snapshots	array<object>	The backup snapshots.
	object	The list of backup snapshots.
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 deduplicated data size of backup snapshots. 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 for retrieving the next page of backup snapshots.	caeba0bbb2be03f84eb48b699f0a

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.