Help Center> Document Database Service> API Reference> API Description> DB Instance Management> Changing a Database Port
View PDF

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 /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 DB instance ID.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    port

    Yes

    Integer

    Specifies the port number. The port number ranges from 2100 to 9500.
  • Request header 
    POSThttps://DDS endpoint/v3/{project_id}/instances/{instance_id}/modify-port
  • Example request 
    {
    "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

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management