All Products
Search

This Product

    Bastionhost:ListDatabaseAccountsForUserGroup

    Document Center

    Bastionhost:ListDatabaseAccountsForUserGroup

    Last Updated:Nov 27, 2024

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:ListDatabaseAccountsForUserGroup
    *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-pe334a03o0h
    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. 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
    DatabaseIdstringYes

    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
    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
    DatabaseAccountNamestringNo

    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 parameters

    ParameterTypeDescriptionExample
    object
    DatabaseAccountsarray<object>

    The database accounts returned.

    itemobject
    DatabaseAccountIdstring

    The ID of the database account.

    		4
    DatabaseAccountNamestring

    The name of the database account.

    		root
    DatabaseIdstring

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

    		11
    IsAuthorizedboolean

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

    • true
    • false
    		true
    ProtocolNamestring

    The protocol used by the database account. Valid values:

    • MySQL
    • Oracle
    • PostgreSQL
    • SQLServer
    		MySQL
    RequestIdstring

    The request ID.

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

    The total number of database accounts returned.

    		10

    Examples

    Sample success responses

    JSONformat

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

    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.