All Products
Search
Document Center

Data Management:EditLogicDatabase

Last Updated:Oct 21, 2024

Edits the information about a logical 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
AliasstringYes
  • The alias of the logical database. If you want to change the alias, specify a new alias.
  • If you do not need to change the alias of the logical database, call the GetLogicDatabase or GetDBTopology operation to query the alias of the logical database.
test_logic_db
LogicDbIdlongYes

The ID of the logical database. You can call the ListLogicDatabases operation to query the ID of the logical database.

1***
DatabaseIdsarrayYes
  • The IDs of the physical databases that compose the logical database. If you want to change the physical databases, you can call the ListDatabases or SearchDatabase operation to query the IDs of the new physical databases that you want to specify.
  • If you do not want to change the physical databases, you can call the GetDBTopology operation to query the IDs of the physical databases that compose the logical database.
longYes
1860****
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

C51420E3-144A-4A94-B473-8662FCF4AD10
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrorMessagestring

The error message.

UnknownError
ErrorCodestring

The error code.

UnknownError

Examples

Sample success responses

JSONformat

{
  "RequestId": "C51420E3-144A-4A94-B473-8662FCF4AD10",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-23The internal configuration of the API is changed, but the call is not affectedView Change Details