Queries the details of the databases.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dms:SearchDatabase | list | *All Resources * |
| none |
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. | 3*** |
SearchKey | string | Yes | The keyword that is used to search for databases. | testdb |
PageNumber | integer | Yes | The number of the page to return. | 1 |
PageSize | integer | No | The number of entries to return on each page. | 10 |
EnvType | string | No | The environment type of the database. For more information, see Change the environment type of an instance. | test |
SearchRange | string | No | The query range based on permissions. Valid values:
| HAS_PERMSSION |
SearchTarget | string | No | The category of the database. Valid values:
| SINGLE_DB |
DbType | string | No | The type of the database. For more information about the valid values of this parameter, see DbType parameter. | MYSQL |
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalCount": 1,
"RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
"SearchDatabaseList": {
"SearchDatabase": [
{
"DatabaseId": "2528****",
"Host": "rm-xxxx.mysql.rds.aliyuncs.com",
"DbaId": "10****",
"SchemaName": "test",
"Logic": false,
"DatalinkName": "datalink_name",
"Port": 3306,
"EnvType": "test",
"Sid": "testSid",
"OwnerIdList": {
"OwnerIds": [
"1"
]
},
"Encoding": "utf8",
"DbType": "mysql",
"OwnerNameList": {
"OwnerNames": [
"user1"
]
},
"SearchName": "test@xxx.xxx.xxx.xxx:3306",
"Alias": "test_rds",
"CatalogName": "dmstest"
}
]
},
"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 |
---|---|---|
2024-08-22 | The internal configuration of the API is changed, but the call is not affected | View Change Details |