Updated on 2026-01-08 GMT+08:00

Changing a Database Port

API Description

This API is used to change a database port.

Restrictions

  • This operation cannot be performed on frozen or abnormal instances.
  • The DB instance must be restarted to make changes take effect. Exercise caution when modifying the database port.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-port

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Table 3 Parameter description

Parameter

Type

Mandatory

Description

port

Integer

Yes

The port number. Value range: 2100 to 65535 (excluding 12017 and 33071)

  • Request example
    {
        "port": 8888
    }

Response Parameters

Table 4 Parameter description

Parameter

Type

Mandatory

Description

job_id

String

Yes

The workflow ID.

port

Integer

Yes

The port number.

  • Example response
    {
         "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
         "port": 8888
     }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.