doc-exports/docs/dds/api-ref/dds_api_0054.html

Changing a Database Port

Function

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 port number modifications take effect. Exercise caution when modifying the database port.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  instance_id	Yes	Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.

Requests

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  port	Yes	Integer	Specifies the port number. The port is in range 2100 to 9500, or 27017, 27018, or 27019.

• Example request
  POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-port

  {
      "port": 8888
  }

Responses

• Parameter description

  Table 3 Parameter description

  Name	Type	Description
  job_id	String	Indicates the workflow ID.
  port	Integer	Indicates the port number.

• Response example

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

Status Code

Status Code:200.

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management