Data Management:GetDatabase - Data Management

Gets the details of a specified Database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetDatabase

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant API to obtain this ID.	-1
Host	string	Yes	The endpoint of the database.	192.168.XX.XX
Port	integer	Yes	The database connection port.	3306
Sid	string	No	The database SID. Note The database SID is the unique identifier for an Oracle database.	test_sid
SchemaName	string	Yes	The database name.	mysql
RealLoginUserUid	string	No	None.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3CDB8601-AD74-4A47-8114-08E08CD6****
Database	object	The details of the database.
DatabaseId	string	The database ID.	984****
Host	string	The database endpoint.	192.168.XX.XX
CatalogName	string	The name of the database catalog.	def
DbaName	string	The DBA's nickname.	dba_name
State	string	The state of the database. Valid values: NORMAL: The database is running. DISABLED: The database is disabled. OFFLINE: The database is offline. NOT_EXIST: The database does not exist.	NORMAL
DbaId	string	The user ID of the DBA.	27****
SchemaName	string	The schema name.	mysql
InstanceId	string	The instance ID.	149****
Port	integer	The port used to connect to the database.	3306
EnvType	string	The environment type of the database. Valid values: product: production dev: development pre: pre-release test: test sit: system integration testing (SIT) uat: user acceptance testing (UAT) pet: performance testing stag: staging	product
Sid	string	The SID of the database. Note This parameter is returned only for Oracle databases.	test_sid
OwnerIdList	object	The IDs of the database owners.
OwnerIds	array	A list of User IDs of the database owner.
	string	The user ID of a database owner.	27****
Encoding	string	The character set.	utf8mb4
DbType	string	The database engine type. For more information, see the description of the DbType parameter.	mysql
OwnerNameList	object	The nicknames of the database owners.
OwnerNames	array	List of Database Owner nicknames.
	string	The nickname of a database owner.	test
SearchName	string	The name 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 was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.