Create a Database Account via CreateDatabaseAccount API - Bastionhost - Alibaba Cloud - Bastionhost

After a database is created, you can create a database account for it. After the account is created, O&M engineers can use the account to log on to and manage the database.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host instance for which you want to create a database account. Note You can call the DescribeInstances operation to query this parameter.	bastionhost-cn-5yd34ol020a
RegionId	string	No	The region ID of the bastion host for which you want to create a database account. Note For the mapping between region IDs and region names, see Regions and zones.	cn-shanghai
DatabaseId	string	Yes	The instance ID of the database for which you want to create an account. Note You can invoke the ListDatabaseAccounts operation to query this parameter.	3
DatabaseAccountName	string	Yes	The name of the database account to create. The name can be up to 128 characters in length.	root
Password	string	No	The password of the database account to create.	MCQ******
DatabaseSchema	string	No	The database name. This parameter is required when the database corresponding to DatabaseId is PostgreSQL or Oracle.	orcl
LoginAttribute	string	No	The logon attribute. This parameter is required for Oracle databases. Valid values: SERVICENAME SID	SID
		No	The project ID.

Response elements

Element	Type	Description	Example
	object
DatabaseAccountId	string	The database account ID.	40
RequestId	string	The request ID.	B07C465D-B09F-54DD-8FEC-90788BEABAFC

Examples

Success response

JSON format

{
  "DatabaseAccountId": "40",
  "RequestId": "B07C465D-B09F-54DD-8FEC-90788BEABAFC"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	DatabaseAccountAlreadyExists	The database account already exists.	The database account already exists.
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.