文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 修改数据库端口
更新时间：2024-09-03 GMT+08:00
查看PDF
分享

修改数据库端口

功能介绍

修改数据库实例的端口。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Redis

冻结实例，异常实例不支持该操作。

GeminiDB Redis和GeminiDB Cassandra的容灾实例不支持单独修改端口，只能随着主实例联动修改。GeminiDB Redis实例的负载均衡端口会同步修改。

修改端口后，后台会重启实例，请谨慎操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/port

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

port

是

Integer

新端口号。

GeminiDB Mongo副本集4.0数据库实例端口有效范围为2100~9500，暂不支持8636、8637和8638。

GeminiDB Cassandra数据库实例端口有效范围为2100~9500，暂不支持7000，7001，7199，8636，8479，8484，8999，8018，2180，2887，3887，8079，8091，8092。

GeminiDB Redis数据库实例端口有效范围为1024~65535,暂不支持2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、9864、9866、9867、12017、12333、50069。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

  • URI样例 
    PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/c865f921f3dd45198f209a607533a779in06/port
  • 修改数据库端口为“8888” 
    { 
  "port" : 8888 
}

响应示例

状态码： 202

Accepted

{ 
  "job_id" : "89638f5e-0780-497c-b3c0-4d0968383e19" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档