Changing a Database Port

API Description

This API is used to change a database port.

Constraints

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 /v3/{project_id}/instances/{instance_id}/modify-port
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-port

**Table 1** Path parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	string	path	Explanation: 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. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
port	Integer	Yes	Explanation: The port number. Constraints: N/A Value range: Value range: 2100 to 65535 (excluding 12017 and 33071) Default value: N/A

Example Requests

Changing a database port number to 8888

{
    "port": 8888
}

Response Parameters

Parameter description

**Table 4** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	Explanation: The workflow ID. Value range: N/A
port	Integer	Yes	Explanation: The port number. Value range: N/A

Example Responses

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

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.