Queries the details about Tablestore instances that are backed up.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOtsTableSnapshots

The operation that you want to perform. Set the value to DescribeOtsTableSnapshots.

StartTime Long No 1607436917

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

EndTime Long No 1607536917

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

SnapshotIds Array of String No s-00047mxg17p26****3c

The list of snapshot IDs.

OtsInstances Array No

The list of Tablestore instances that are backed up.

InstanceName String No instancename

The name of the Tablestore instance.

TableNames Array of String No tablename

The names of the tables in the Tablestore instance.

Limit Integer No 100

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

NextToken String No caeba0bbb2be03f84eb48b699f0a****

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

Response parameters

Parameter Type Example Description
RequestId String 09376812-6290-5E36-B504-E8010D72D1F0

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
Code String 200

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

Message String successful

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

Limit Integer 10

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

Snapshots Array of Snapshot

The list of backup snapshots.

Status String COMPLETE

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.
SnapshotHash String f2fe...

The hash value of the backup snapshot.

VaultId String v-00030j*******sn

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

BackupType String COMPLETE

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

CreateTime Long 1607436917

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

ActualBytes String 0

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

SourceType String OTS_TABLE

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
BytesTotal Long 0

The total amount of data. Unit: bytes.

CompleteTime Long 1642496679

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

Retention Long 730

The retention period of the backup snapshot.

CreatedTime Long 1642496679

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

ParentSnapshotHash String f2fe..

The hash value of the parent backup snapshot.

StartTime Long 1642496543

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

UpdatedTime Long 1642496679

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

SnapshotId String s-00047mxg17p26*****b

The ID of the backup snapshot.

JobId String job-00030j3chkt******2

The ID of the backup job.

InstanceName String instancename

The name of the Tablestore instance.

TableName String table2

The name of the table in the Tablestore instance.

RangeStart Long 1642492553038

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

RangeEnd Long 1642521709966

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

NextToken String caeba0bbb2be03f84eb48b699f0a

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

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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