All Products
Search
Document Center

Bastionhost:ListDatabasesForUserGroup

Last Updated:Sep 19, 2024

Queries the databases that a user group is authorized to manage.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ListDatabasesForUserGroup
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The bastion host ID.

Note You can call the DescribeInstances operation to query the bastion host ID.
bastionhost-cn-7mz2ve7h00a
RegionIdstringNo

The region ID of the bastion host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
UserGroupIdstringYes

The ID of the user group to query.

2
PageNumberstringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page.
Valid values: 1 to 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
DatabaseNamestringNo

The name of the database to query.

test
DatabaseAddressstringNo

The address of the database to query. Only exact match is supported.

47.101.**.**
DatabaseTypestringNo

The engine of the database to query. Valid values:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL

Response parameters

ParameterTypeDescriptionExample
object
Databasesarray<object>

The databases returned.

object
ActiveAddressTypestring

The address type of the database. Valid values:

  • Public
  • Private
Private
Commentstring

The remarks of the database.

comment
DatabaseAccountCountlong

The total number of database accounts returned.

2
DatabaseIdstring

The ID of the database to which the database account belongs.

2
DatabaseNamestring

The name of the database.

MySQL0
DatabasePortlong

The port of the database.

3306
DatabasePrivateAddressstring

The internal address of the database. The value is a domain name or an IP address.

rm-bp1******
DatabasePublicAddressstring

The public address of the database. The value is a domain name or an IP address.

rm-uf65******
DatabaseTypestring

The database engine. Valid values:

  • MySQL
  • Oracle
  • PostgreSQL
  • SQLServer
MySQL
NetworkDomainIdstring

The ID of the network domain where the database resides.

5
Sourcestring

The type of the database. Valid values:

  • Local: on-premises database.
  • Rds: ApsaraDB RDS instance.
  • PolarDB: PolarDB cluster.
Local
SourceInstanceIdstring

The ID of the ApsaraDB RDS instance or PolarDB cluster.

Note No value is returned for this parameter if Source is set to Local.
i-wz9c7mjxywmdmqk7q6e4
RequestIdstring

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCountlong

The total number of databases returned.

15

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.