All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyDatabaseDescription

Last Updated:Oct 23, 2024

You can call this operation to modify the description of an OceanBase database.

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 description of the database.

ob317v4uif****
TenantIdstringYes

The operation that you want to perform.
Set the value to ModifyDatabaseDescription.

ob2mr3oae0****
DatabaseNamestringYes

Example 1

sms_pre
DescriptionstringYes
this is a test database

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
No change history