ListOperationDatabases - Bastionhost - Alibaba Cloud Documentation Center

Lists the databases that the current Resource Access Management (RAM) user is authorized to access.

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 ID of the Bastionhost instance. Note Call the DescribeInstances operation to obtain this parameter.	bastionhost-cn-tl32wdd
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information, see Regions and zones.	cn-shanghai
PageNumber	string	No	The page number. The default value is 1.	1
PageSize	string	No	The number of entries to return on each page. The maximum value is 100. The default value is 20. If you do not specify this parameter, 20 entries are returned. Note Specify a value for this parameter.	20
DatabaseType	string	No	The database type. Valid values: MySQL SQLServer Oracle PostgreSQL	MySQL
DatabaseName	string	No	The name of the database. This parameter supports only exact matches.	aaa
DatabaseAddress	string	No	The address of the database.	10.167.XX.XX
Source	string	No	The source of the database. Valid values: Local: a local database Rds: an ApsaraDB RDS database PolarDB: a PolarDB database	Local
SourceInstanceId	string	No	The ID of the source instance. This parameter supports only exact matches.	i-bp19ienyt0yax748****
SourceInstanceState	string	No	The status of the source instance. You can use this parameter to filter the results. Normal: The instance is running. RemoteRelease: The instance is released.	Normal

Response elements

Element	Type	Description	Example
	object
Databases	array<object>	The databases.
	object
ActiveAddressType	string	The endpoint type of the database. Valid values: Public: a public endpoint Private: a private endpoint	Private
Comment	string	The comment on the database.	cpp
DatabaseId	string	The ID of the database.	26
DatabaseName	string	The name of the database.	zDatabase
DatabasePort	integer	The database port.	3306
DatabasePrivateAddress	string	The private endpoint of the database.	rm-b******9b.mysql.rds.aliyuncs.com
DatabasePublicAddress	string	The public endpoint 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. Local: a local database Rds: an ApsaraDB RDS database PolarDB: a PolarDB database	Local
SourceInstanceId	string	The ID of the source instance.	i-wz9225bhipya******
SourceInstanceRegionId	string	The region ID of the source instance.	cn-shanghai
SourceInstanceState	string	The status of the source instance: Normal: The instance is running. Release: The instance is 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.