All Products
Search
Document Center

Bastionhost:ListDatabaseAccounts

Last Updated:Sep 19, 2024

Queries the database accounts of a database.

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:ListDatabaseAccounts
  • 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-7mz2za0ro06
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-shanghai
DatabaseIdstringNo

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

Note You can call the ListDatabases operation to query the database ID.
3
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 returned database accounts.

object
DatabaseAccountIdstring

The database account ID.

59
DatabaseAccountNamestring

The name of the database account.

test
DatabaseIdstring

The database ID.

4
DatabaseSchemastring

The name of the database. A value is returned for this parameter if the engine of the database with the specified database ID is PostgreSQL or Oracle.

orcl
HasPasswordstring

Indicates whether the database account has a password. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

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

The total number of database accounts returned.

10

Examples

Sample success responses

JSONformat

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