Modifies the endpoint and port of an instance.
Operation description
Supported database engines
- MySQL
- PostgreSQL
- SQL Server
- MariaDB
References
- Change the endpoint and port number of an ApsaraDB RDS for MySQL instance
- Change the endpoint and port number of an ApsaraDB RDS for PostgreSQL instance
- Change the endpoint and port number of an ApsaraDB RDS for SQL Server instance
- Change the endpoint and port number of an ApsaraDB RDS for MariaDB instance
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 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:ModifyDBInstanceConnectionString | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5**** |
CurrentConnectionString | string | Yes | The endpoint of the instance. It can be an internal endpoint, a public endpoint, or a classic network endpoint in hybrid access mode. Note
The read/write splitting endpoint cannot be changed.
| rm-uf6wjk5x****.mysql.rds.aliyuncs.com |
ConnectionStringPrefix | string | Yes | The prefix of the endpoint after the change. Only the prefix of the value of CurrentConnectionString can be changed. Note
The value must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). The value cannot contain any of the following special characters: ! # % ^ & * = + | {} ; : ' " ,<> / ?
| rm-**** |
Port | string | Yes | The port number after the change. | 3306 |
BabelfishPort | string | No | The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled. Note
This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.
| 1433 |
GeneralGroupName | string | No | The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. | rgc-bp1tkv8**** |
PGBouncerPort | string | No | The PgBouncer port. Note
This parameter is suitable only for ApsaraDB RDS for PostgreSQL instances. If you enable PgBouncer for your instance, you can change the PgBouncer port of the instance.
| 6432 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | DnsConflict | Dns is conflict with other custins. | The DNS server conflicts with other clients. |
400 | InvalidConnectionString.Malformed | The specified parameter ConnectionStringPrefix is not valid. | - |
400 | OperationDenied.DBInstanceStatus | The operation is not permitted due to status of instance. | The instance status does not support the operation. |
400 | InvalidConnectionString.NotFound | The specified connection string or network type is not found. | The endpoint cannot be found. Check the endpoint. |
400 | MissingConnectionString | The request is missing a ConnectionString parameter. | You must specify ConnectionString. |
400 | OtherEndpoint.Exist | Other endpoint exist. | The prefix of the public endpoint already exists. |
400 | Endpoint.NotFound | Specified endpoint is not found. | The port that is associated with the dedicated proxy endpoint cannot be found. |
400 | InvalidPort.Format | Specified Port is not valid. | The specified port is invalid. |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
400 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. |
400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. |
400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
400 | pay.noCreditCard | Account not bound to credit card. | - |
400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | - |
400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
404 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | The endpoint is duplicate. Specify a different endpoint. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-03-14 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-06-27 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
| ||||||||||||
2022-09-01 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-06-23 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-04-25 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-04-25 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
|