Queries the details of logical databases.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListLogicDatabases |
The operation that you want to perform. Set the value to ListLogicDatabases. |
Tid | Long | Yes | 3422 |
The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID. |
PageNumber | Integer | Yes | 1 |
The number of the page to return. |
PageSize | Integer | No | 50 |
The number of entries to return on each page. |
RegionId | String | No | cn-hangzhou |
The ID of the region in which Data Management (DMS) is activated. Set this parameter to the ID of the region that is in proximity to your applications. For more information about the valid values of this parameter, see RegionID parameter. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Long | 7 |
The total number of logical databases. |
LogicDatabaseList | Array of LogicDatabase |
The details of logical databases. |
|
LogicDatabase | |||
DatabaseId | String | 1*** |
The ID of the logical database. |
OwnerIdList | Array of String | 51**** |
The IDs of the owners of the logical database. |
DbType | String | polardb |
The type of the logical database. For more information about the valid values of this parameter, see DbType parameter. |
OwnerNameList | Array of String | owner_name |
The names of the owners of the logical database. |
Logic | Boolean | true |
Indicates whether the database is a logical database. The return value is true. |
SchemaName | String | logic_db |
The name of the logical database. |
SearchName | String | logic_db[logic_db_alias] |
The name that is used to search for the logical database. |
EnvType | String | test |
The type of the environment to which the logical database belongs. Valid values:
|
Alias | String | logic_db_alias |
The alias of the logical database. |
RequestId | String | 8068AF82-8A1A-592C-AC2E-6B75338BAB87 |
The ID of the request. |
ErrorCode | String | UnknownError |
The error code that is returned. |
ErrorMessage | String | UnknownError |
The error message that is returned. |
Success | Boolean | true |
Indicates whether the request is successful. Valid values:
|
Examples
Sample requests
http(s)://dms-enterprise.aliyuncs.com/?Action=ListLogicDatabases
&Tid=3***
&PageNumber=1
&PageSize=50
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListLogicDatabasesResponse>
<TotalCount>7</TotalCount>
<LogicDatabaseList>
<DatabaseId>1***</DatabaseId>
<OwnerIdList>51****</OwnerIdList>
<DbType>polardb</DbType>
<OwnerNameList>owner_name</OwnerNameList>
<Logic>true</Logic>
<SchemaName>logic_db</SchemaName>
<SearchName>logic_db[logic_db_alias]</SearchName>
<EnvType>test</EnvType>
<Alias>logic_db_alias</Alias>
</LogicDatabaseList>
<RequestId>8068AF82-8A1A-592C-AC2E-6B75338BAB87</RequestId>
<Success>true</Success>
</ListLogicDatabasesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 7,
"LogicDatabaseList" : [ {
"DatabaseId" : "1***",
"OwnerIdList" : [ "51****" ],
"DbType" : "polardb",
"OwnerNameList" : [ "owner_name" ],
"Logic" : true,
"SchemaName" : "logic_db",
"SearchName" : "logic_db[logic_db_alias]",
"EnvType" : "test",
"Alias" : "logic_db_alias"
} ],
"RequestId" : "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
"Success" : true
}
Error codes
For a list of error codes, visit the API Error Center.