文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 修改/关闭M兼容端口
更新时间：2024-11-04 GMT+08:00
查看PDF
分享

修改/关闭M兼容端口

功能介绍

修改或关闭GaussDB M兼容端口功能。

调试

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

接口约束

修改或关闭M兼容端口的实例需存在templatem模板数据库，如果不存在，则会自动创建templatem模板数据库。副本一致性协议为Paxos的实例，暂不支持创建templatem模板数据库。

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/mysql-compatibility

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

port

是

string

M兼容端口，可选范围为：0, 1024-39989。

  • 如下端口不可设置： 2378，2379，2380，2400，4999，5000，5001，5100，5500，5999，6000，6001，6009，6010，6500，8015，8097，8098，8181，9090，9100，9180，9187，9200，12016，12017，20049，20050，21731，21732，32122，32123，32124，32125，32126，39001，[数据库端口, 数据库端口+10]。
  • 取值为0，表示关闭M兼容端口。

响应参数

表3 参数说明

参数

参数类型

描述

job_id

String

任务ID。

请求示例

  • 修改M兼容端口为3307。 
    PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
{ 
  "port" : "3307"
}
  • 关闭M兼容端口。 
    PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
{ 
  "port" : "0"
}

响应示例

修改/关闭M兼容端口成功。

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档