All Products
Search

This Product

    Bastionhost:ModifyDatabase

    Document Center

    Bastionhost:ModifyDatabase

    Last Updated:Sep 29, 2026

    Modifies the basic information of 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

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance to which the database to be modified belongs.

    Note

    You can call the DescribeInstances operation to obtain this parameter.

    bastionhost-cn-72137xe5n01
    RegionId

    string

    No

    The region ID of the Bastionhost instance to which the database to be modified belongs.

    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 be modified.

    11
    NetworkDomainId

    string

    No

    The ID of the network domain to which the database belongs after the modification.

    Note

    You can call the ListNetworkDomains operation to obtain this parameter.

    2
    ActiveAddressType

    string

    No

    The address type of the database after the modification. Valid values:

    • Public: public network address

    • Private: private network address

    Public
    DatabasePrivateAddress

    string

    No

    The private network address of the database after the modification. IPv4 addresses and domain name formats are supported.

    192.168.XX.XX
    DatabasePublicAddress

    string

    No

    The public address of the database after the modification. Both IPv4 addresses and domain names are supported.

    www.example.com
    DatabasePort

    string

    No

    The port of the database after the modification.

    5433
    DatabaseName

    string

    No

    The name of the database instance after the modification.

    pgsql
    SourceInstanceId

    string

    No

    The instance ID of the database to be modified.

    Note

    This parameter is required if Source is set to Rds or PolarDB.

    i-wz99nexqd62z3bvuvpz5
    Comment

    string

    No

    The description of the database after the modification.

    tttttttt
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique identifier generated by Alibaba Cloud for the request.

    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.