Changing the Port of a Proxy Instance

Function

This API is used to change the port of a proxy instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/port

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 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 contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
port	Yes	Integer	Definition New port of the proxy instance. Constraints N/A Range 1025 to 65534, excluding 1033, 5342 to 5345, 12017, 20000, 20201, 20202, 33062, and 33071 Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition ID of the task for changing the port of a proxy instance. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Changing the port of a proxy instance

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy/fbece38953e24a2b891488ed2fdf81abpo01/port
{
  "port" : 3308
}

Example Response

Status code: 200

Success.

{
  "job_id" : "********"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy

Previous topic: Changing the Connection Pool Type of a Proxy Instance

Next topic: Upgrading the Kernel Version of a Proxy Instance

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