Updated on 2026-05-30 GMT+08:00

Changing an Instance Port

Function

This API is used to change an instance port.

Constraints

None

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

port

Yes

Integer

Port number

Example Request

Changing an instance port to 5067
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/port
{
  "port" : 5067
}

Response Parameters

  • Normal response
    Table 3 Response body parameters

    Parameter

    Type

    Description

    job_id

    String

    Job ID

Example Response

  • Normal response example
    {
      "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
    }

Status Codes

Error Codes

For details, see Error Codes.