Changing a Database Port¶
Function¶
This API is used to change the database port of a DB 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}/port
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID of a tenant in a region. |
instance_id | Yes | String | Instance ID of a tenant in a project. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
port | Yes | Integer | Port number. Value range: 1024 to 65535, excluding 5342 to 5345, 12017, 20000, 20201, 20202, and 33062. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
job_id | String | Task ID. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/port
{
"port" : 8836
}
Example Response¶
Status code: 200
Success.
{
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.