文档首页> 文档数据库服务 DDS> API参考> API v3（推荐）> 实例管理> 修改数据库端口
更新时间：2024-04-01 GMT+08:00
查看PDF

修改数据库端口

接口说明

修改数据库实例的端口。

约束说明

  • 冻结实例，异常实例不支持该操作。
  • 修改端口后，后台会重启实例，请谨慎操作。

URI

  • URI格式

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

  • URI样例

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

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

从IAM服务获取的用户Token。请参考认证鉴权。

project_id

string

path

是

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    port

    Integer

    是

    新端口号。端口有效范围为2100~65535（不包括12017和33071）。

请求示例

修改数据库端口为8888。 
{
    "port": 8888
}

响应消息

  • 参数说明
    表3 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    是

    工作流ID。

    port

    Integer

    是

    新端口号。
  • 响应示例
    {
     "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
     "port": 8888
 }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理