ListDatabasesForUserGroup - Bastionhost - Alibaba Cloud Documentation Center

Queries the list of databases that are authorized for a user group.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance. Note You can call the DescribeInstances operation to obtain this parameter.	bastionhost-cn-7mz2ve7h00a
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
UserGroupId	string	Yes	The ID of the user group for which you want to query authorized databases.	2
PageNumber	string	No	The page number of the 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. By default, 20 entries are returned on each page. If you leave the PageSize parameter empty, 20 entries are returned. Note We recommend that you do not leave the PageSize parameter empty.	20
DatabaseName	string	No	The name of the database instance that you want to query.	test
DatabaseAddress	string	No	The address of the database that you want to query. Only term query is supported.	47.101..
DatabaseType	string	No	The type of the database that you want to query. Valid values: MySQL Oracle PostgreSQL SQLServer	MySQL
NetworkDomainId	string	No	The ID of the network domain.	2

Response elements

Element	Type	Description	Example
	object
Databases	array<object>	The list of databases that are queried.
	object
ActiveAddressType	string	The type of the database address. Valid values: Public: public address Private: private address	Private
Comment	string	The description of the database instance.	comment
DatabaseAccountCount	integer	The total number of database accounts that are queried.	2
DatabaseId	string	The ID of the database instance to which the database account belongs.	2
DatabaseName	string	The name of the database instance.	MySQL0
DatabasePort	integer	The port of the database.	3306
DatabasePrivateAddress	string	The private endpoint of the database, which can be a domain name or an IP address.	rm-bp1******
DatabasePublicAddress	string	The public address of the database, which can be a domain name or an IP address.	rm-uf65******
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.	5
Source	string	The source of the database. Valid values: Local: local database instance Rds: RDS database instance PolarDB: PolarDB database instance	Local
SourceInstanceId	string	The ID of the RDS instance or PolarDB instance that corresponds to the database. Note If Source is set to Local, this parameter is empty.	i-wz9c7mjxywmdmqk7q6e4
RequestId	string	The unique ID that Alibaba Cloud generates for the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCount	integer	The total number of databases that are queried.	15

Examples

Success response

JSON format

{
  "Databases": [
    {
      "ActiveAddressType": "Private",
      "Comment": "comment",
      "DatabaseAccountCount": 2,
      "DatabaseId": "2",
      "DatabaseName": "MySQL0",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-bp1******",
      "DatabasePublicAddress": "rm-uf65******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "5",
      "Source": "Local",
      "SourceInstanceId": "i-wz9c7mjxywmdmqk7q6e4"
    }
  ],
  "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.