文档

DescribeOtsTableSnapshots - 查询表格存储备份详情

更新时间:

查询表格存储备份详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
StartTimelong

备份开始时间。UNIX 时间,单位为毫秒。

1611109271630
EndTimelong

备份结束时间。UNIX 时间,单位为毫秒。

1652068250881
SnapshotIdsarray

快照列表。

string

快照 ID 列表。

s-00047mxg17p26****3c
OtsInstancesobject []

备份的表格存储实例列表。

InstanceNamestring

备份的表格存储实例名称。

instancename
TableNamesarray

备份的表格存储数据表名称。

string

备份的表格存储数据表名称。

tablename
Limitinteger

本次查询需要返回的最大数量。

100
NextTokenstring

获取下一页快照所需的 Token。

caeba0bbb2be03f84eb48b699f0a****
CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
CROSS_ACCOUNT
CrossAccountUserIdlong

用于跨账号备份的原账号 Uid。

144015xxxxx98732
CrossAccountRoleNamestring

用于跨账号备份的原账号 RAM 中创建的角色名。

BackupRole

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

09376812-6290-5E36-B504-E8010D72D1F0
Successboolean

请求是否成功。

  • true:成功。
  • false:失败。
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
Limitinteger

当前页显示快照数量。

10
Snapshotsobject []

快照列表。

Statusstring

备份快照任务的状态。取值范围:

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
COMPLETE
SnapshotHashstring

快照 HASH 值。

f2fe...
VaultIdstring

保存备份库快照的仓库 ID。

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

备份类型。取值为 COMPLETE,表示全量备份。

COMPLETE
CreateTimelong

表示表格存储创建时间。UNIX 时间,单位为秒。

1607436917
ActualBytesstring

去重后快照实际数据量。单位为字节。

0
SourceTypestring

数据源类型。取值范围:

  • ECS_FILE:ECS 文件的备份快照。
  • OSS:阿里云 OSS 的备份快照。
  • NAS:阿里云 NAS 的备份快照。
  • OTS_TABLE:阿里云表格存储的备份快照。
OTS_TABLE
BytesTotallong

数据源总量。单位为字节。

0
CompleteTimelong

备份快照完成时间。UNIX 时间,单位为秒。

1642496679
Retentionlong

备份快照保留天数。

730
CreatedTimelong

备份快照的创建时间。UNIX 时间,单位为秒。

1642496679
ParentSnapshotHashstring

父备份的快照 HASH 值。

f2fe..
StartTimelong

快照开始时间。UNIX 时间,单位为秒。

1642496543
UpdatedTimelong

备份快照的更新时间。UNIX 时间,单位为秒。

1642496679
SnapshotIdstring

备份快照 ID。

s-00047mxg17p26*****b
JobIdstring

备份任务 ID。

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

表格存储实例名称。

instancename
TableNamestring

表格存储实例的数据表名称。

table2
RangeStartlong

备份任务开始执行时间。UNIX 时间,单位为毫秒。

1642492553038
RangeEndlong

备份任务结束执行时间。UNIX 时间,单位为毫秒。

1642521709966
NextTokenstring

获取下一页快照所需的 Token。

caeba0bbb2be03f84eb48b699f0a

示例

正常返回示例

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈