GetDatabase - Data Management - Alibaba Cloud Documentation Center

Queries details of a specific 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

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:GetDatabase	get	All Resources ``	none	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 ID of the tenant.	-1
Host	string	Yes	The endpoint that is used to connect to the database.	192.168.XX.XX
Port	integer	Yes	The port that is used to connect to the database.	3306
Sid	string	No	The system identifier (SID) of the database. Note The SID uniquely identifies an Oracle database. After a database is created, a SID is generated for the database.	test_sid
SchemaName	string	Yes	The name of the database.	mysql

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	3CDB8601-AD74-4A47-8114-08E08CD6****
Database	object	The details of the database.
DatabaseId	string	The ID of the database.	984****
Host	string	The endpoint that is used to connect to the database.	192.168.XX.XX
CatalogName	string	The name of the catalog to which the database belongs.	def
DbaName	string	The nickname of the DBA.	dba_name
State	string	The status of the database. Valid values: NORMAL: The database is running as expected. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
DbaId	string	The ID of the database administrator (DBA).	27****
SchemaName	string	The name of the database.	mysql
InstanceId	string	The ID of the instance.	149****
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. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: SIT environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	product
Sid	string	The SID of the database. Note The value of the parameter is returned only for Oracle databases.	test_sid
OwnerIdList	array	The IDs of the owners of the database.
OwnerIds	string		27****
Encoding	string	The encoding format of the database.	utf8mb4
DbType	string	The type of the database. For more information about the valid values of this parameter, see DbType parameter.	mysql
OwnerNameList	array	The names of the owners of the database.
OwnerNames	string		test
SearchName	string	The keyword that is used to search for the database.	mysql@192.168.XX.XX:3306
InstanceAlias	string	The alias of the instance.	test
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	An unknown error occurred.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "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