All Products
Search
Document Center

Cloud Backup:DescribeRecoverableOtsInstances

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CrossAccountTypestringNo

The type of cross-account backup. Supported:

  • SELF_ACCOUNT: backup of this account
  • CROSS_ACCOUNT: Cross-account backup
CROSS_ACCOUNT
CrossAccountUserIdlongNo

The Alibaba Cloud Uid of the original account used to cross accounts.

1440155109798732
CrossAccountRoleNamestringNo

The role name created in the RAM of the original account used for cross-account backup.

hbrcrossrole

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
OtsInstancesobject []

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

Examples

Sample success responses

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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history