文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 实例管理/ 开启M兼容端口 - EnablingMCompatibilityPort
更新时间:2026-07-07 GMT+08:00
分享

开启M兼容端口 - EnablingMCompatibilityPort

功能介绍

开启GaussDB M兼容端口。

调试

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

接口约束

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

URI

POST /v3/{project_id}/instances/{instance_id}/mysql-compatibility

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文
  • en-us:英文

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

port

string

参数解释:

M兼容端口。

约束限制:

如下端口不可设置: 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]。

取值范围:

1024-39989。

默认取值

不涉及。

响应参数

表4 要素说明

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

请求示例

开启M兼容端口3306。
POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
{ 
  "port" : 3306
}

响应示例

开启M兼容端口成功。

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

状态码

错误码

请参见错误码

相关文档