Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing or Disabling M Compatibility Port
Updated on 2025-08-11 GMT+08:00

Changing or Disabling M Compatibility Port

Function

This API is used to change or disable the M compatibility port. Before calling this API:

Constraints

To change or disable this function, you need to ensure that there is the templatem template database in your DB instance. If there is no the template database, it will be automatically created. The templatem template database cannot be created for DB instances whose replica consistency protocol is Paxos.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

port

Yes

string

Definition

Port for M compatibility.

Constraints

This port cannot be one of the following: 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, and any port in the range [database_port,database_port + 10].

Range

0, 1024–39989

Default Value

0: The port is disabled.

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

N/A

Example Request

  • Changing the M compatibility port to 3307
    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
    { 
      "port" : "3307"
    }
  • Disabling M compatibility port
    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
    { 
      "port" : "0"
    }

Example Response

M compatibility port changed or disabled.

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.