GetDatabase - Bastionhost - Alibaba Cloud Documentation Center

Queries the detailed information about a 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

yundun-bastionhost:GetDatabase

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host that manages the database to query. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-wwo36qbv601
RegionId	string	No	The region ID of the bastion host that manages the database to query. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
DatabaseId	string	Yes	The ID of the database to query. Note You can call the ListDatabases operation to query the database ID.	21

Response elements

Element	Type	Description	Example
	object
Database	object	The returned detailed information about the database.
ActiveAddressType	string	The address type of the database. Valid values: Public Private	Public
Comment	string	The remarks of the database.	comment
DatabaseId	string	The database ID.	22
DatabaseName	string	The name of the database.	test
DatabasePort	integer	The port of the database.	3306
DatabasePrivateAddress	string	The internal endpoint of the database.	rm-bp1zq******
DatabasePublicAddress	string	The public endpoint of the database.	rm-uf65******
DatabaseType	string	The database engine. Valid values: mysql sqlserver postgresql oracle	MySQL
NetworkDomainId	string	The ID of the network domain to which the database belongs.	45
Source	string	The database type. Valid values: Local: on-premises database. Rds: ApsaraDB RDS instance. PolarDB: PolarDB cluster.	Local
SourceInstanceId	string	The ID of the ApsaraDB RDS instance or PolarDB cluster. Note If Source is set to Local, this parameter is empty.	i-wz9527ob0e0nftcsffke
SourceInstanceRegionId	string	The region ID of the ApsaraDB RDS instance or PolarDB cluster.	cn-hangzhou
SourceInstanceState	string	The status of the database. Valid values: Normal Release	Normal
RequestId	string	The request ID.	4D72B883-9D15-5B05-B987-DFD10EB1FFB4

Examples

Success response

JSON format

{
  "Database": {
    "ActiveAddressType": "Public",
    "Comment": "comment",
    "DatabaseId": "22",
    "DatabaseName": "test",
    "DatabasePort": 3306,
    "DatabasePrivateAddress": "rm-bp1zq******",
    "DatabasePublicAddress": "rm-uf65******",
    "DatabaseType": "MySQL",
    "NetworkDomainId": "45",
    "Source": "Local",
    "SourceInstanceId": "i-wz9527ob0e0nftcsffke",
    "SourceInstanceRegionId": "cn-hangzhou",
    "SourceInstanceState": "Normal"
  },
  "RequestId": "4D72B883-9D15-5B05-B987-DFD10EB1FFB4"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	DatabaseNotFound	The database is not found.	The database is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.