Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing the Port Number of a Specified DB Instance
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Changing the Port Number of a Specified DB Instance

Function

This API is used to change the port number of a specified DB instance. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

PUT /v3/{project_id}/instances/{instance_id}/port

Table 1 Parameter description

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

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

port

Yes

Integer

Definition

Database port number set for the instance.

Constraints

N/A

Range

1024–39998 (excluding the following system-reserved ports: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 60001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124).

Default Value

N/A

Response Parameters

Table 4 Parameter description

Parameter

Type

Description

job_id

String

Definition

ID of the job for modifying the port.

Range

N/A

Example Request

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/port
{
	"port": 8001
}

Example Response

{
  "job_id": "e51532df-b94d-4fbc-9cf0-aea030ade45d"
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Instance Management