Help Center/ Cloud Data Center / API Reference/ API/ iMetal Instance Management/ Changing the IP Address of an Instance
Updated on 2025-07-25 GMT+08:00

Changing the IP Address of an Instance

Function

This API is used to select a specified iMetal instance and change its IP address.

The iMetal instance must be ready (commissioned successfully) or the IP address fails to be changed and the iMetal instance is powered off.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/instances/{id}/ip

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

The project ID of the account

Default Value

N/A

id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

vpc_id

No

String

Definition

ID of the VPC which the network interface to be created belongs to. You can query the ID using the VPC API: https://support.huaweicloud.com/intl/en-us/api-vpc/vpc_api01_0003.html

Constraints

N/A

Range

VPC ID

Default Value

N/A

nics

No

Array of nics objects

Definition

Network interface information.

Constraints

N/A

Response Parameters

Status code: 202

The IP address of the instance has been changed.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 429

Table 6 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Request for changing the IP address of an instance

GET https://{endpoint}/v1/{project_id}/instances/{id}/ip

Example Responses

None

Status Codes

Status Code

Description

202

The IP address of the instance has been changed.

400

Invalid request parameter.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

For details, see Error Codes.