Use ListOperationDatabases to list authorized databases - Bastionhost - Alibaba Cloud - Bastionhost

Retrieves the list of databases authorized for the current Resource Access Management (RAM) user.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the bastion host. Note You can call the DescribeInstances operation to query the value of this parameter.	bastionhost-cn-tl32wdd
RegionId	string	No	The region ID of the bastion host. Note For the mappings between region IDs and region names, see Regions and zones.	cn-shanghai
PageNumber	string	No	The page number of the current page for a paged query. Default value: 1.	1
PageSize	string	No	The maximum number of entries to return on each page for a paged query. The maximum value of the PageSize parameter is 100. Default value: 20. If the PageSize parameter is left empty, 20 entries are returned by default. Note Do not leave the PageSize parameter empty.	20
DatabaseType	string	No	The database type. Valid values: MySQL SQLServer Oracle PostgreSQL	MySQL
DatabaseName	string	No	The name of the database instance. Exact match is used.	aaa
DatabaseAddress	string	No	The address of the database instance.	10.167.XX.XX
Source	string	No	The source of the database instance. Valid values: Local: on-premises database Rds: ApsaraDB RDS database PolarDB: PolarDB database	Local
SourceInstanceId	string	No	The instance ID of the ApsaraDB RDS instance. Exact match.	i-bp19ienyt0yax748****
SourceInstanceState	string	No	Filters database instances by instance status. Valid values: Normal: normal RemoteRelease: released	Normal
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
Databases	array<object>	The list of database instances.
	object
ActiveAddressType	string	The address type of the database. Valid values: Public: The public network address is valid. Private: The private network address is valid.	Private
Comment	string	The description of the database instance.	cpp
DatabaseId	string	The instance ID of the database.	26
DatabaseName	string	The name of the database instance.	zDatabase
DatabasePort	integer	The port of the database.	3306
DatabasePrivateAddress	string	The private network address of the database.	rm-b******9b.mysql.rds.aliyuncs.com
DatabasePublicAddress	string	The public IP address of the database.	rm-uf******p45.mysql.rds.aliyuncs.com
DatabaseType	string	The database type. Valid values: MySQL PostgreSQL Oracle SQLServer	MySQL
Source	string	The source of the database instance. Valid values: Local: on-premises host Rds: ApsaraDB RDS database PolarDB: PolarDB database	Local
SourceInstanceId	string	The instance ID of the ApsaraDB RDS instance.	i-wz9225bhipya******
SourceInstanceRegionId	string	The region ID of the source ApsaraDB RDS instance.	cn-shanghai
SourceInstanceState	string	The status of the database instance. 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.	15

Examples

Success response

JSON format

{
  "Databases": [
    {
      "ActiveAddressType": "Private",
      "Comment": "cpp",
      "DatabaseId": "26",
      "DatabaseName": "zDatabase",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-b******9b.mysql.rds.aliyuncs.com",
      "DatabasePublicAddress": "rm-uf******p45.mysql.rds.aliyuncs.com",
      "DatabaseType": "MySQL",
      "Source": "Local",
      "SourceInstanceId": "i-wz9225bhipya******",
      "SourceInstanceRegionId": "cn-shanghai",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 15
}

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.