ModifyDatabase - Bastionhost - Alibaba Cloud Documentation Center

Modifies the basic information about a 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:ModifyDatabase

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host that manages the database to modify. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-72137xe5n01
RegionId	string	No	The region ID of the bastion host that manages the database to modify. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
DatabaseId	string	Yes	The ID of the database to modify.	11
NetworkDomainId	string	No	The ID of the new network domain for the database. Note You can call the ListNetworkDomains operation to query the network domain ID.	2
ActiveAddressType	string	No	The new address type of the database. Valid values: Public Private	Public
DatabasePrivateAddress	string	No	The new internal address of the database. Specify an IPv4 address or a domain name.	192.168.XX.XX
DatabasePublicAddress	string	No	The new public address of the database. Specify an IPv4 address or a domain name.	www.example.com
DatabasePort	string	No	The new port of the database.	5433
DatabaseName	string	No	The new name of the database.	pgsql
SourceInstanceId	string	No	The ID of the ApsaraDB for RDS instance or PolarDB cluster to modify. Note This parameter is required if Source is set to Rds or PolarDB.	i-wz99nexqd62z3bvuvpz5
Comment	string	No	The new remarks of the database.	tttttttt

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	162088A7-7D47-56A3-9D04-93DE7B6DBE1C

Examples

Success response

JSON format

{
  "RequestId": "162088A7-7D47-56A3-9D04-93DE7B6DBE1C"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	DatabaseAlreadyExists	The database already exists.	The database already exists.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	DatabaseNotFound	The database is not found.	The database is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.