All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeBackupEncryptedString

Last Updated:Nov 14, 2025

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob4wib********
TenantIdstringYes

The ID of the tenant.

txxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

The return data of the request.

BackupInfoJsonstring

Information about the overall encrypted backup data.

xxxxxxxx (encrypted string)

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "BackupInfoJson": "xxxxxxxx (encrypted string)"
  }
}

Error codes

For a list of error codes, visit the Service error codes.