Help Center> Document Database Service> API Reference> APIs V3.0 (Recommended)> DB Instance Management> Changing a Database Port
Updated on 2022-12-12 GMT+08:00
View PDF

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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-port

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

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.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    port

    Integer

    Yes

    The port number. Valid port range and ports: 2100 to 9500, 27017, 27018, and 27019.
  • Request example
    {
    "port": 8888
}

Responses

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    The workflow ID.

    port

    Integer

    Yes

    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