Changing a Database Port¶
Function¶
This API is used to change a database port.
Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.
Constraints¶
Changing of port will affect RDS instance access. Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.
The database port cannot be changed when a DB instance is being created or rebooted, its specifications are being modified, database users are being created or deleted, or backups are being created for the DB instance.
URI¶
URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/port
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
Request¶
Parameter description
Table 2 Parameter description¶ Name
Mandatory
Type
Description
port
Yes
Integer
Specifies port information for all DB engines.
The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).
The PostgreSQL database port ranges from 2100 to 9500.
The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985).
The default values is as follows:
The default value of MySQL is 3306.
The default value of PostgreSQL is 5432.
The default value of Microsoft SQL Server is 1433.
Example
Request example
{ "port": 8836 }
Response¶
Normal response
Name
Description
workflowId
Indicates the workflow ID.
For details about how to query this parameter, see Obtaining Task Information.
Example normal response
{ "workflowId":"83abc7bc-2c70-4534-8565-351187b37715" }Abnormal response
For details, see Abnormal Request Results.
Status Code¶
Normal
200
Abnormal
For details, see Status Codes.
Error Code¶
For details, see Error Codes.