Changes an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
Operation description
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:ModifyDBProxyEndpointAddress | update |
|
| 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-t4n3a**** |
DBProxyEndpointId | string | Yes | The ID of the dedicated proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID of the proxy endpoint. | ta9um4**** |
DBProxyNewConnectString | string | No | The new prefix of the proxy endpoint. Enter a prefix. Note
You must specify at least one of the DBProxyNewConnectString and DBProxyNewConnectStringPort parameters.
| test123456 |
DBProxyNewConnectStringPort | string | No | The port number that is associated with the proxy endpoint. Enter a port number. Note
You must specify at least one of the DBProxyNewConnectString and DBProxyNewConnectStringPort parameters.
| 3307 |
DBProxyConnectStringNetType | string | No | The network type of the proxy endpoint. Valid values:
If the instance runs MySQL, the default value of this parameter is Classic. Note
If the instance runs PostgreSQL, you must set this parameter to Public or VPC.
| Public |
DBProxyEngineType | string | No | A reserved parameter. You do not need to specify this parameter. | normal |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidConnectionString.Format | Specified connection string is not valid. | The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length. |
400 | InvalidPort.Malformed | Specified port is not valid. | The port number is invalid. |
400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | The endpoint is duplicate. Specify a different endpoint. |
400 | InvalidConnectionStringOrPort.Duplicate | Specified connection string or port want to be modified is the same with current net type. | The endpoint or the port number is duplicate. Modify the endpoint or the port number. |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string. |
400 | OtherEndpoint.Exist | Other endpoint already exist. | - |
400 | MaxscaleNotSupport | Current custins can not support Maxscale. | This operation is not supported for instances with maxscale. |
400 | ParameterLeastAssociate | Must input at least one optional parameter | You must enter at least one selectable parameter. |
403 | ParameterLeastAssociate | Must input at least one optional parameter. | The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again. |
403 | NetTypeChangeTimesExceeded | Exceeding the daily net type change times of the DB instance. | - |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | The endpoint cannot be found. Check the endpoint. |
404 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | - |
404 | Endpoint.NotFound | Specified endpoint is not found. | The port that is associated with the dedicated proxy endpoint cannot be found. |
404 | Maxscale.NotFound | The related maxscale instance is not found. | The operation failed. No associated MaxScale instances can be found. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-19 | The Error code has changed | View Change Details |
2023-09-08 | The Error code has changed | View Change Details |
2022-06-08 | The Error code has changed. The request parameters of the API has changed | View Change Details |