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

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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/mysql-compatibility

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the value, see Obtaining a Project ID.

Restrictions:

None

Value range:

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

Default value:

None

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

port

Yes

string

Port for M compatibility. Value range: 0 or 1024 to 39989

  • The following ports are used by the system and cannot be used: 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, [Database port, Database port + 10].
  • If the value is 0, the port is disabled.

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

Task ID.

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.

Parent topic: Instance Management