All Products
Search

This Product

    Bastionhost:ListDatabaseAccounts

    Document Center

    Bastionhost:ListDatabaseAccounts

    Last Updated:Sep 29, 2026

    Retrieves a list of database accounts.

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

    get

    *All Resource

    *

    		 None 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 query the Bastionhost instance ID.

    bastionhost-cn-7mz2za0ro06
    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-shanghai
    DatabaseId

    string

    No

    The ID of the database instance for which you want to query database accounts.

    Note

    You can call the ListDatabases operation to query the database instance ID.

    3
    PageNumber

    string

    No

    The page number of the current page in a paging query. Default value: 1.

    1
    PageSize

    string

    No

    The maximum number of entries to return on each page in a paging query.
    The maximum value of the PageSize parameter is 100. Default value: 20. If this parameter is left empty, 20 entries are returned by default.

    Note

    Specify a value for the PageSize parameter.

    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
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    DatabaseAccounts

    array<object>

    The list of database accounts.

    object

    DatabaseAccountId

    string

    The ID of the database account.

    59
    DatabaseAccountName

    string

    The name of the database account.

    test
    DatabaseId

    string

    The ID of the database instance.

    4
    DatabaseSchema

    string

    The name of the database. A value is returned only when the database specified by DatabaseId is a PostgreSQL or Oracle database.

    orcl
    HasPassword

    string

    Indicates whether a password is set for the database account. Valid values:

    • true: A password is set.

    • false: No password is set.

    true
    RequestId

    string

    The unique identifier generated by Alibaba Cloud for the request.

    4F6C075F-FC86-476E-943B-097BD4E12948
    TotalCount

    integer

    The total number of database accounts.

    10

    Examples

    Success response

    JSON format

    {
  "DatabaseAccounts": [
    {
      "DatabaseAccountId": "59",
      "DatabaseAccountName": "test",
      "DatabaseId": "4",
      "DatabaseSchema": "orcl",
      "HasPassword": "true"
    }
  ],
  "RequestId": "4F6C075F-FC86-476E-943B-097BD4E12948",
  "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.