All Products
Search

This Product

    Data Management:SearchDatabase

    Document Center

    Data Management:SearchDatabase

    Last Updated:Oct 21, 2024

    Queries the details of the 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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
    SearchDatabaseListarray<object>

    The information about the databases.

    SearchDatabaseobject

    The information about the database.

    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.

    OwnerIdsstring

    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.

    OwnerNamesstring

    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
    2024-08-22The internal configuration of the API is changed, but the call is not affectedView Change Details