All Products
Search
Document Center

Data Management:SearchDatabase

Last Updated:Apr 18, 2024

Queries the details of the 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:SearchDatabaseRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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

3***
SearchKeystringYes

The keyword that is used to search for databases.

testdb
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

10
EnvTypestringNo

The environment type of the database. For more information, see Change the environment type of an instance.

test
SearchRangestringNo

The query range based on permissions. Valid values:

  • HAS_PERMSSION: searches for databases on which the current user has permissions.
  • OWNER: searches for databases owned by the current user.
  • MY_FOCUS: searches for databases that the current user follows.
  • UNKNOWN: searches for all databases.
HAS_PERMSSION
SearchTargetstringNo

The category of the database. Valid values:

  • DB: single database or logical database.
  • SINGLE_DB: single database.
  • LOGIC_DB: logical database.
SINGLE_DB
DbTypestringNo

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

MYSQL

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of entries returned.

1
RequestIdstring

The ID of the request.

E0D21075-CD3E-4D98-8264-FD8AD04A63B6
SearchDatabaseListobject []

The information about the databases.

DatabaseIdstring

The ID of the database.

2528****
Hoststring

The endpoint of the instance in which the database resides.

rm-xxxx.mysql.rds.aliyuncs.com
DbaIdstring

The ID of the user who assumes the database administrator (DBA) role.

10****
SchemaNamestring

The name of the database.

test
Logicboolean

Indicates whether the database is a logical database. Valid values:

  • true: The database is a logical database.
  • false: The database is not a logical database.
false
DatalinkNamestring

The name of the data link for cross-database queries.

datalink_name
Portinteger

The port of the instance in which the database resides.

3306
EnvTypestring

The environment type of the database. For more information, see Change the environment type of an instance.

test
Sidstring

The system ID (SID) of the instance in which the database resides.

testSid
OwnerIdListarray

The IDs of the owners of the databases.

string

The ID of the owner of the database.

1
Encodingstring

The encoding method of the database.

utf8
DbTypestring

The type of the database engine.

mysql
OwnerNameListarray

The nicknames of the database owners.

string

The nickname of the database owner.

user1
SearchNamestring

The name that is used to search for the database.

test@xxx.xxx.xxx.xxx:3306
Aliasstring

The alias of the database.

test_rds
CatalogNamestring

The name of the catalog to which the database belongs.

Note If the type of the database engine is PostgreSQL, the name of the database is displayed.
dmstest
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

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": 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 timeSummary of changesOperation
No change history