Enabling M Compatibility Port

Function

This API is used to enable the M compatibility port. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Constraints

To enable 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

POST /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 1024–39989 Default Value N/A

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
job_id	String	Definition Job ID. Range N/A

Example Request

Enabling M compatibility port and setting it to 3306

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility
{ 
  "port" : 3306
}

Example Response

M compatibility port enabled.

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Normal
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management

Previous topic: Stopping a DB Instance or Node

Next topic: Changing or Disabling M Compatibility Port

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot