GetPhysicalDatabase - Data Management - Alibaba Cloud Documentation Center

Queries the details of a physical database.

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
DbId	long	Yes	The ID of the physical database. You can call the SearchDatabase operation to obtain the ID.	43153
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the ID of the tenant.	1

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Database	object	The information about the physical database.
DatabaseId	string	The ID of the physical database.	43125312
Host	string	The endpoint that is used to connect to the database.	rm-xxxab3r272.mysql.rds.aliyuncs.com
CatalogName	string	The name of the catalog to which the database belongs. Note : If the database is a PostgreSQL database, the name of the database is displayed.	def
DbaName	string	The nickname of the database administrator (DBA) in the destination database.	dmstest
State	string	The state of the database. Valid values: NORMAL: The database is normal. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
DbaId	string	The user ID of the DBA in the destination database.	43253
SchemaName	string	The name of the database. Note : If the database is a PostgreSQL database, the name of the mode is displayed.	dmstest
InstanceId	string	The instance ID of the destination database.	43215325
Port	integer	The port that is used to connect to the database.	3306
EnvType	string	The type of the environment to which the database belongs. For more information, see Change the environment type of an instance.	product
Sid	string	The system ID (SID) of the database. Note : The value of the parameter is returned only for Oracle databases.	def
OwnerIdList	array	The user IDs of the database owners.
OwnerIds	string	The user ID of the database owner.	43215325
Encoding	string	The encoding format of the database.	utf8mb4
DbType	string	The type of the database engine.	mysql
OwnerNameList	array	The nicknames of the database owners.
OwnerNames	string	The nickname of the database owner.	dmstest
SearchName	string	The name that is used for searching the database.	dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306
InstanceAlias	string	The alias of the database instance.	test
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Database": {
    "DatabaseId": "43125312",
    "Host": "rm-xxxab3r272.mysql.rds.aliyuncs.com",
    "CatalogName": "def",
    "DbaName": "dmstest",
    "State": "NORMAL",
    "DbaId": "43253",
    "SchemaName": "dmstest",
    "InstanceId": "43215325",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "def",
    "OwnerIdList": {
      "OwnerIds": [
        "43215325"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "dmstest"
      ]
    },
    "SearchName": "dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306",
    "InstanceAlias": "test"
  },
  "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
2023-05-18	The response structure of the API has changed	View Change Details