All Products
Search
Document Center

Cloud Backup:DescribeRecoverableOtsInstances

Last Updated:Dec 17, 2024

Queries the tables of a restorable Tablestore instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hbr:DescribeRecoverableOtsInstancesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CrossAccountTypestringNo

Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:

  • SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account.
  • CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.
CROSS_ACCOUNT
CrossAccountUserIdlongNo

The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

1440155109798732
CrossAccountRoleNamestringNo

The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

hbrcrossrole

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The response code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

successful
OtsInstancesarray<object>

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

OtsInstanceobject

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.

TableNamestring

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