ListLogicDatabases - Data Management - Alibaba Cloud Documentation Center

Queries the detailed information about logical databases.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3422
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	50

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of logical databases.	7
LogicDatabaseList	array<object>	The details of logical databases.
LogicDatabase	object	The details of logical databases.
DatabaseId	string	The ID of the logical database.	1***
OwnerIdList	array	The IDs of the owners of the logical database.
OwnerIds	string	Logical database Owner ID.	51****
DbType	string	The type of the logical database. For more information about the valid values of this parameter, see DbType parameter.	polardb
OwnerNameList	array	The names of the owners of the logical database.
OwnerNames	string	The name of the owner of the logical database.	owner_name
Logic	boolean	Indicates whether the database is a logical database. The return value is true.	true
SchemaName	string	The name of the logical database.	logic_db
SearchName	string	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]
EnvType	string	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
Alias	string	The alias of the logical database.	logic_db_alias
DatabaseIds	array	Logical database sub-ID list.
DatabaseIds	long	Logical database sub-ID.	12****
RequestId	string	The ID of the request.	8068AF82-8A1A-592C-AC2E-6B75338BAB87
ErrorCode	string	The error code that is returned.	UnknownError
ErrorMessage	string	The error message that is returned.	UnknownError
Success	boolean	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 time	Summary of changes	Operation

No change history