All Products
Search
Document Center

Data Management:ListLogicDatabases

Last Updated:Mar 14, 2024

Queries the details of logical databases.

Debugging

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

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
dms:ListLogicDatabasesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3422
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

50

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of logical databases.

7
LogicDatabaseListobject []

The details of logical databases.

DatabaseIdstring

The ID of the logical database.

1***
OwnerIdListarray

The IDs of the owners of the logical database.

string

Logical database Owner ID.

51****
DbTypestring

The type of the logical database. For more information about the valid values of this parameter, see DbType parameter.

polardb
OwnerNameListarray

The names of the owners of the logical database.

string

The name of the owner of the logical database.

owner_name
Logicboolean

Indicates whether the database is a logical database. The return value is true.

true
SchemaNamestring

The name of the logical database.

logic_db
SearchNamestring

The name that is used to search for the logical database.

Note We recommend that you do not use this parameter for business development. The format of the parameter value may be modified in later versions.
logic_db[logic_db_alias]
EnvTypestring

The type of the environment to which the logical database belongs. Valid values:

  • product: production environment
  • dev: development environment
  • pre: staging environment
  • test: test environment
  • sit: system integration testing (SIT) environment
  • uat: user acceptance testing (UAT) environment
  • pet: stress testing environment
  • stag: STAG environment
test
Aliasstring

The alias of the logical database.

logic_db_alias
DatabaseIdsarray

Logical database sub-ID list.

long

Logical database sub-ID.

12****
RequestIdstring

The ID of the request.

8068AF82-8A1A-592C-AC2E-6B75338BAB87
ErrorCodestring

The error code that is returned.

UnknownError
ErrorMessagestring

The error message that is returned.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "TotalCount": 7,
  "LogicDatabaseList": {
    "LogicDatabase": [
      {
        "DatabaseId": "1***",
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "DbType": "polardb",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "Logic": true,
        "SchemaName": "logic_db",
        "SearchName": "logic_db[logic_db_alias]",
        "EnvType": "test",
        "Alias": "logic_db_alias",
        "DatabaseIds": {
          "DatabaseIds": [
            0
          ]
        }
      }
    ]
  },
  "RequestId": "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history