Updated on 2025-09-04 GMT+08:00

Changing a Database Port

Function

This API is used to change a database port.

Constraints

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 /v3/{project_id}/instances/{instance_id}/port

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

port

Yes

Integer

Specifies the port number.

  • The RDS for MySQL port number ranges from 1024 to 65535, excluding 12017, 33062, and 33071.
  • The RDS for PostgreSQL port number ranges from 2100 to 9500.

Example Request

Change the database port of a DB instance to 8836.

{
     "port": 8836
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Workflow ID.

  • Example normal response
    {
        "workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.