All Products
Search
Document Center

Hybrid Backup Recovery:DescribeRecoverableOtsInstances

Last Updated:Nov 14, 2022

Queries the Tablestore instances that can be restored and the tables in the instances.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The reponse body.

RequestIdstring

The ID of the request.

14DC089E-5DD3-5028-AEDB-93D78E11DB2A
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
OtsInstancesarray

The list of Tablestore instances that can be restored and the tables in the instances.

object

The list of Tablestore instances that can be restored and the tables in the instances.

InstanceNamestring

The name of the Tablestore instance that can be restored.

instancename
TableNamesarray

The names of the tables in the Tablestore instance.

string

The names of the tables in the Tablestore instance.

["table1", "table2", "table3"]

Example

Request example

http(s)://[Endpoint]/?Action=DescribeRecoverableOtsInstances
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "14DC089E-5DD3-5028-AEDB-93D78E11DB2A",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "OtsInstances": [
    {
      "InstanceName": "instancename",
      "TableNames": [
        "[\"table1\", \"table2\", \"table3\"]"
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.