Files
doc-exports/docs/ddm/api-ref/en-us_topic_0000002217069689.html
wangdengke2 823df869a9 ddm_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-03 12:01:43 +00:00

15 KiB

Changing an Instance Port (a V3 API)

Function

This API is used to change an instance port.

Constraints

None

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

For how to obtain a project ID, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body. Value range:

  • application/json
  • application/json;charset=utf-8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

port

Yes

Integer

Port number

Example Request

Changing an instance port to 5067
POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/port
{
  "port" : 5067
}

Response Parameters

  • Normal response
    Table 4 Response body parameters

    Parameter

    Type

    Description

    job_id

    String

    Job ID

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

    For details, see Abnormal Request Results.

Status Codes

Error Codes

For details, see Error Codes.