DescribeRecoverableTables--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeRecoverableTables

最近更新时间：2024.08.27 14:45:46首次发布时间：2023.11.30 10:27:54

调用 DescribeRecoverableTables 接口查询指定实例可恢复的库和表。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-6jvx8d7w****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
BackupId	String	否	snap-63f4****-8dff	备份文件 ID。通过调用 DescribeBackups 接口可查询 `BackupID`。说明该参数与 `RestoreTime` 参数二者必选其一。
RestoreTime	String	否	2023-05-09T15:07:25Z	实例备份保留周期内的任意时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。通过调用 DescribeRecoverableTime 可查询实例备份可恢复的时间范围。说明该参数与 `BackupId` 参数二者必选其一。
DBName	String	否	db_test	数据库名称。若传入该参数，则返回指定数据库下可恢复的所有表。若不传入该参数，则返回可恢复的数据库列表。
PageSize	Integer	是	1000	每页记录数。取值范围 1~1000。
PageNumber	Integer	是	1	页码，取值大于等于 1，且不超过 Integer 的最大值。

返回参数

名称	类型	示例值	描述
DBTableInfos	Array of DBTableInfoObject	请参见返回示例。	实例的库表信息。关于 DBTableInfos 的详细信息，请参见DBTableInfoObject。

请求示例

POST /?Action=DescribeRecoverableTables&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20230828T084117Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkOD******/20230828/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c87******

{
    "InstanceId":"vedbm-dfaa2zic****",
    "RestoreTime":"2023-09-25T08:18:10Z",
    "PageSize":1000,
    "PageNumber":1,
    "DBName":"testdb1"
}

返回示例

指定 DBName 参数

{
    "ResponseMetadata": {
        "RequestId": "2023092516270861B6A9D5989B6B1DA2E8",
        "Action": "DescribeRecoverableTables",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBTableInfos": [
            {
                "Database": "testdb3",
                "DatabaseRecoverable": false,
                "Tables": [
                    "table1",
                    "table2",
                    "table3",
                    "table4",
                    "table5"
                ],
                "TablesInfo": {
                    "table6": {
                        "TableRecoverable": false
                    },
                    "table7": {
                        "TableRecoverable": false
                    },
                    "table8": {
                        "TableRecoverable": false
                    }
            }
        ]
    }
}

不指定 DBName 参数

{
    "ResponseMetadata": {
        "RequestId": "2023092516262161B6A9D5989B6B1D87DC",
        "Action": "DescribeRecoverableTables",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBTableInfos": [
            {
                "Database": "testdb1",
                "DatabaseRecoverable": true
            },
            {
                "Database": "testdb2",
      "DatabaseRecoverable": true
            }
        ]
    }
}

错误码

更多详情，请参见错误码。