更新时间:2025-11-21 GMT+08:00
分享

修改数据库端口 - UpdatePort

功能介绍

修改数据库实例端口。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:modifyPort

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

实例在创建、重启、变更规格、创建备份、创建用户、删除用户等状态下不能修改数据库端口。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/port

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

port

Integer

参数解释

端口号。

约束限制

不涉及。

取值范围

  • RDS for MySQL端口号范围:大于等于1024,小于等于65535,不包含12017、33062和33071。
  • RDS for PostgreSQL端口号范围:2100~9500。
  • 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版:端口设置范围为1433和2100~9500(其中5050、5353、5355、5985和5986不可设置)。

    除此之外的其他版本:端口设置范围为1433和2100~9500(其中5355、5985和5986不可设置)。

默认取值

不涉及。

请求示例

修改数据库实例的端口为8836。

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/port
{
     "port": 8836
}

响应消息

  • 正常响应要素说明

    名称

    说明

    workflowId

    参数解释

    任务ID。

    取值范围

    不涉及。

  • 正常响应样例
    {
        "workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档