Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Database Security/ Changing a Database Port
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Changing a Database Port

Function

This API is used to change a database port.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:modifyPort

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

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

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

port

Yes

Integer

Definition

Specifies the port number.

Constraints

N/A

Range

  • 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.
  • For RDS for SQL Server 2022 Enterprise Edition, 2022 Standard Edition, 2022 Web Edition, 2019 Enterprise Edition, 2019 Standard Edition, 2019 Web Edition, 2017 Enterprise Edition, 2017 Standard Edition, and 2017 Web Edition, the port number can be set to 1433 or 2100 to 9500 (excluding 5050, 5353, 5355, 5985, and 5986).

    For other editions, the port number can be set to 1433 or 2100 to 9500 (excluding 5355, 5985, and 5986).

Default Value

N/A

Example Request

Change the database port of a DB instance to 8836.

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/port

{
     "port": 8836
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Definition

    Workflow ID.

    Range

    N/A
  • 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.

Parent topic: Database Security