Help Center/ Elastic Cloud Server/ API Reference/ OpenStack Nova APIs/ Status Management/ Locking an ECS
Updated on 2022-09-23 GMT+08:00
View PDF

Locking an ECS

Function

This API is used to lock an ECS.

You are only allowed to lock your own ECSs. After ECSs are locked, you will not be able to perform management operations on them, including life cycle management, status management, NIC management, disk management, and password management.

URI

POST /v2.1/{project_id}/servers/{server_id}/action

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

server_id

Yes

Specifies the ECS ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Type

Mandatory

Description

lock

Null

Yes

Locks an ECS.

Response

None

Example Request

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
{
    "lock": null
}

Example Response

None

Returned Values

See Returned Values for General Requests.

Parent topic: Status Management