All Products
Search

This Product

    Bastionhost:ListDatabaseAccountsForUserGroup

    Document Center

    Bastionhost:ListDatabaseAccountsForUserGroup

    Last Updated:Jan 21, 2026

    Queries the database accounts of a database and whether a user group is authorized to manage each database account.

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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The bastion host ID.

    Note

    You can call the DescribeInstances operation to query the bastion host ID.

    bastionhost-cn-pe334a03o0h
    RegionId

    string

    No

    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
    UserGroupId

    string

    Yes

    The ID of the user group to query. This operation returns whether the user group is authorized to manage each database account.

    Note

    You can call the ListUserGroups operation to query the user group ID.

    3
    DatabaseId

    string

    Yes

    The ID of the database whose database accounts you want to query.

    Note

    You can call the ListDatabaseAccounts operation to query the database account ID.

    36
    PageNumber

    string

    No

    The page number. Default value: 1.

    1
    PageSize

    string

    No

    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
    DatabaseAccountName

    string

    No

    The name of the database account to query. The name can be up to 128 characters in length. Only exact match is supported.

    test

    Response elements

    Element

    Type

    Description

    Example

    object

    DatabaseAccounts

    array<object>

    The database accounts returned.

    object

    DatabaseAccountId

    string

    The ID of the database account.

    4
    DatabaseAccountName

    string

    The name of the database account.

    root
    DatabaseId

    string

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

    11
    IsAuthorized

    boolean

    Indicates whether the user group is authorized to manage the database account. Valid values:

    • true

    • false

    true
    ProtocolName

    string

    The protocol used by the database account. Valid values:

    • MySQL

    • Oracle

    • PostgreSQL

    • SQLServer

    MySQL
    RequestId

    string

    The request ID.

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

    integer

    The total number of database accounts returned.

    10

    Examples

    Success response

    JSON format

    {
  "DatabaseAccounts": [
    {
      "DatabaseAccountId": "4",
      "DatabaseAccountName": "root",
      "DatabaseId": "11",
      "IsAuthorized": true,
      "ProtocolName": "MySQL"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 10
}

    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.