Modifies the basic information about a database.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-bastionhost:ModifyDatabase |
|
| 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 |
| DatabasePrivateAddress | string | No | The new internal address of the database. Specify an IPv4 address or a domain name. | pc-bp169****** |
| DatabasePublicAddress | string | No | The new public address of the database. Specify an IPv4 address or a domain name. | pgm-uf6c****** |
| 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 parameters
Examples
Sample success responses
JSONformat
{
"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. |
| 404 | DatabaseNotFound | The database is not found. | The database is not found. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.