Updated on 2024-03-28 GMT+08:00

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.

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 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 the port number.

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

Example Request

Changing the database port of a DB instance to 8836

{
     "port": 8836
}

Response

  • Normal response

    Name

    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.