查询可恢复 OceanBase 租户。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oceanbase:DescribeRestorableTenants | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
| IsRemote | boolean | 否 | 为兼容老版本，可以为空。 | true |
| SetId | string | 否 | 备份集 ID。 | bak-xxxxx |
| RestoreMode | string | 否 | 恢复方式。非必填，在 IsRemote=true 时，必填。 | from_time_point |
| Method | string | 否 | 备份类型。 | native_logical |
| IsOnline | boolean | 否 | 目标解析集群是否在线。 说明
为兼容旧版本时可以不填，不填时值为对 isRemote 取反。
| true |
| RestoreObjectType | string | 否 | 恢复对象类型。 | tenant |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 6,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Tenants": [
{
"TenantName": "sbtest1",
"Method": "logical",
"TenantId": "ob317v4uif****",
"TimeIntervalList": [
{
"StartTime": "2023-01-20T16:00:00Z",
"EndTime": "2023-03-13T02:43:03Z",
"FromArchive": true,
"StorageType": "standard"
}
],
"ClusterId": "objnf3b2****",
"ObRpmVersion": "3.2.3.1-2022080510****",
"ObVersion": "3.2.3.1",
"SourceRegion": "cn-hangzhou",
"TenantAlias": "aaa",
"CpuNum": 1,
"MemoryNum": 100,
"BackupBucketName": "backup",
"ObTenantId": "tvd43v****",
"ClusterName": "testCluster",
"BackupSets": [
{
"Checkpoint": "2024-01-01'T'12:10:10.000'Z'",
"SetId": "bak-xxxxx",
"BackupSetId": "bak-4n****gacpa8",
"TenantId": "t5********"
}
],
"UsedDisk": 50,
"UnitNum": 2,
"TenantMode": "Oracle",
"TenantDataBackupRemainDays": 7
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-02 | OpenAPI 返回结构发生变更 | 查看变更详情 |