All Products
Search
Document Center

Hybrid Backup Recovery:DescribeOtsTableSnapshots

Last Updated:Nov 14, 2022

Queries the details about Tablestore instances that are backed up.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimelongNo

The start time of the backup. This value must be a UNIX timestamp. Unit: seconds.

1611109271630
EndTimelongNo

The end time of the backup. This value must be a UNIX timestamp. Unit: seconds.

1652068250881
SnapshotIdsarrayNo

The list of snapshot IDs.

stringNo

The list of snapshot IDs.

s-00047mxg17p26****3c
OtsInstancesarrayNo

The list of Tablestore instances that are backed up.

objectNo

The list of Tablestore instances that are backed up.

InstanceNamestringNo

The name of the Tablestore instance.

instancename
TableNamesarrayNo

The names of the tables in the Tablestore instance.

stringNo

The names of the tables in the Tablestore instance.

tablename
LimitintegerNo

The maximum number of rows that you want the current query to return.

100
NextTokenstringNo

The token that is required to obtain the next page of backup snapshots.

caeba0bbb2be03f84eb48b699f0a****

Response parameters

ParameterTypeDescriptionExample
object

The reponse doby.

RequestIdstring

The ID of the request.

09376812-6290-5E36-B504-E8010D72D1F0
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
Limitinteger

The number of backup snapshots that are displayed on the current page.

10
Snapshotsarray

The list of backup snapshots.

object

The list of backup snapshots.

Statusstring

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
SnapshotHashstring

The hash value of the backup snapshot.

f2fe...
VaultIdstring

The ID of the backup vault that stores the backup snapshot.

v-00030j*******sn
BackupTypestring

The backup type. Valid value: COMPLETE, which indicates full backup.

COMPLETE
CreateTimelong

The time when the Tablestore instance was created. This value is a UNIX timestamp. Unit: seconds.

1607436917
ActualBytesstring

The actual amount of backup snapshots after duplicates are removed. Unit: bytes.

0
SourceTypestring

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
BytesTotallong

The total amount of data. Unit: bytes.

0
CompleteTimelong

The time when the backup snapshot was completed. This value is a UNIX timestamp. Unit: seconds.

1642496679
Retentionlong

The retention period of the backup snapshot.

730
CreatedTimelong

The time when the backup snapshot was created. This value is a UNIX timestamp. Unit: seconds.

1642496679
ParentSnapshotHashstring

The hash value of the parent backup snapshot.

f2fe..
StartTimelong

The start time of the backup snapshot. This value is a UNIX timestamp. Unit: seconds.

1642496543
UpdatedTimelong

The time when the backup snapshot was updated. This value is a UNIX timestamp. Unit: seconds.

1642496679
SnapshotIdstring

The ID of the backup snapshot.

s-00047mxg17p26*****b
JobIdstring

The ID of the backup job.

job-00030j3chkt******2
InstanceNamestring

The name of the Tablestore instance.

instancename
TableNamestring

The name of the table in the Tablestore instance.

table2
RangeStartlong

The time when the backup job started. This value is a UNIX timestamp. Unit: seconds.

1642492553038
RangeEndlong

The time when the backup job ended. This value is a UNIX timestamp. Unit: seconds.

1642521709966
NextTokenstring

The token that is required to obtain the next page of backup snapshots.

caeba0bbb2be03f84eb48b699f0a

Example

Request example

http(s)://[Endpoint]/?Action=DescribeOtsTableSnapshots
&StartTime=1611109271630
&EndTime=1652068250881
&SnapshotIds=["s-00047mxg17p26****3c"]
&OtsInstances=[{"InstanceName":"instancename","TableNames":["tablename"]}]
&Limit=100
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&Common request parameters

Normal return example

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

Error codes

For a list of error codes, visit the API error center.