Queries the details about Tablestore instances that are backed up.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
StartTime | long | No | The start time of the backup. The value must be a UNIX timestamp. Unit: milliseconds. | 1611109271630 |
EndTime | long | 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 | object [] | No | The 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 that you want the current query to return. | 100 |
NextToken | string | No | The token that is required to obtain the next page of backup snapshots. | caeba0bbb2be03f84eb48b699f0a**** |
CrossAccountType | string | No | Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:
| CROSS_ACCOUNT |
CrossAccountUserId | long | No | The UID of the source account used for cross-account backup. | 144015xxxxx98732 |
CrossAccountRoleName | string | No | The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts. | BackupRole |
Response parameters
Examples
Sample success responses
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
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|