Use the ListDatabases API to query databases - Bastionhost - Alibaba Cloud - Bastionhost

Queries the databases of a specified Bastionhost instance.

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:ListDatabases

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the Bastionhost instance. Note You can invoke the DescribeInstances operation to obtain this parameter.	bastionhost-cn-7mz28f5tk0o
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The page number of the current page for paging in a paged query. Default value: 1.	1
PageSize	string	No	The maximum number of entries to return on each page for paging in a paged query. The maximum value of the PageSize parameter is 100. Default value: 20. If this parameter is left empty, 20 entries are returned by default. Note Do not leave the PageSize parameter empty.	20
DatabaseType	string	No	The type of the database. Valid values: MySQL Oracle PostgreSQL SQLServer	MySQL
NetworkDomainId	string	No	The ID of the network domain to which the database belongs.	2
Source	string	No	The source of the database. Valid values: Local: local database instance Rds: ApsaraDB RDS instance PolarDB: PolarDB instance	Local
HostGroupId	string	No	The ID of the host group. Note You can call the ListHostGroups operation to query the value of this parameter.	20
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
Databases	array<object>	The list of databases.
	object
ActiveAddressType	string	The address type of the database. Valid values: Public: public address Private: private endpoint on the private network	Public
Comment	string	The description of the database.	comment
DatabaseId	string	The instance ID of the database.	9
DatabaseName	string	The name of the database.	MySQL0
DatabasePort	integer	The port number of the database.	3306
DatabasePrivateAddress	string	The private endpoint of the database on the private network, which can be a domain name or an IP address.	rm-wz973w7******
DatabasePublicAddress	string	The public address of the database, which can be a domain name or an IP address.	rm-uf65n2******
DatabaseType	string	The type of the database. Valid values: MySQL Oracle PostgreSQL SQLServer	MySQL
NetworkDomainId	string	The ID of the network domain to which the database belongs.	8
Source	string	The source of the database. Valid values: Local: local database instance Rds: ApsaraDB RDS instance PolarDB: PolarDB instance	Local
SourceInstanceId	string	The instance ID of the ApsaraDB RDS instance or PolarDB instance that corresponds to the database. Note If Source is set to Local, this parameter is empty.	i-wz9ejupczf41******
SourceInstanceRegionId	string	The region ID of the ApsaraDB RDS instance or PolarDB instance that corresponds to the database.	cn-hangzhou
SourceInstanceState	string	The instance status of the database. Valid values: Normal: Normal Release: released	Normal
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCount	integer	The total number of databases returned.	4

Examples

Success response

JSON format

{
  "Databases": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "DatabaseId": "9",
      "DatabaseName": "MySQL0",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-wz973w7******",
      "DatabasePublicAddress": "rm-uf65n2******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "8",
      "Source": "Local",
      "SourceInstanceId": "i-wz9ejupczf41******",
      "SourceInstanceRegionId": "cn-hangzhou",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 4
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.