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

查询表格存储备份详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
hbr:DescribeOtsTableSnapshots	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
StartTime	long	否	备份开始时间。UNIX 时间，单位为毫秒。	1611109271630
EndTime	long	否	备份结束时间。UNIX 时间，单位为毫秒。	1652068250881
SnapshotIds	array	否	快照列表。
	string	否	快照 ID 列表。	s-00047mxg17p26****3c
OtsInstances	array<object>	否	备份的表格存储实例列表。
	object	否	备份的表格存储实例列表。
InstanceName	string	否	备份的表格存储实例名称。	instancename
TableNames	array	否	备份的表格存储数据表名称。
	string	否	备份的表格存储数据表名称。	tablename
Limit	integer	否	本次查询需要返回的最大数量。	100
NextToken	string	否	获取下一页快照所需的 Token。	caeba0bbb2be03f84eb48b699f0a****
CrossAccountType	string	否	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	long	否	用于跨账号备份的原账号 Uid。	144015xxxxx98732
CrossAccountRoleName	string	否	用于跨账号备份的原账号 RAM 中创建的角色名。	BackupRole

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	09376812-6290-5E36-B504-E8010D72D1F0
Success	boolean	请求是否成功。 true：成功。 false：失败。	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
Limit	integer	当前页显示快照数量。	10
Snapshots	array<object>	快照列表。
Snapshot	object
Status	string	备份快照任务的状态。取值范围： COMPLETE：成功 PARTIAL_COMPLETE：部分成功 FAILED：失败	COMPLETE
SnapshotHash	string	快照 HASH 值。	f2fe...
VaultId	string	保存备份库快照的仓库 ID。	v-00030j*******sn
BackupType	string	备份类型。取值为 COMPLETE，表示全量备份。	COMPLETE
CreateTime	long	表示表格存储创建时间。UNIX 时间，单位为秒。	1607436917
ActualBytes	string	去重后快照实际数据量。单位为字节。	0
SourceType	string	数据源类型。取值范围： ECS_FILE：ECS 文件的备份快照。 OSS：阿里云 OSS 的备份快照。 NAS：阿里云 NAS 的备份快照。 OTS_TABLE：阿里云表格存储的备份快照。	OTS_TABLE
BytesTotal	long	数据源总量。单位为字节。	0
CompleteTime	long	备份快照完成时间。UNIX 时间，单位为秒。	1642496679
Retention	long	备份快照保留天数。	730
CreatedTime	long	备份快照的创建时间。UNIX 时间，单位为秒。	1642496679
ParentSnapshotHash	string	父备份的快照 HASH 值。	f2fe..
StartTime	long	快照开始时间。UNIX 时间，单位为秒。	1642496543
UpdatedTime	long	备份快照的更新时间。UNIX 时间，单位为秒。	1642496679
SnapshotId	string	备份快照 ID。	s-00047mxg17p26*****b
JobId	string	备份任务 ID。	job-00030j3chkt******2
InstanceName	string	表格存储实例名称。	instancename
TableName	string	表格存储实例的数据表名称。	table2
RangeStart	long	备份任务开始执行时间。UNIX 时间，单位为毫秒。	1642492553038
RangeEnd	long	备份任务结束执行时间。UNIX 时间，单位为毫秒。	1642521709966
NextToken	string	获取下一页快照所需的 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"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史