Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ Disk Management/ Setting Read-Only Flag for an EVS Disk
Updated on 2024-02-27 GMT+08:00

Setting Read-Only Flag for an EVS Disk

Function

This API is used to set the read-only flag for an EVS disk.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/volumes/{volume_id}/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

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

volume_id

Yes

String

The disk ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

os-update_readonly_flag

Yes

CinderUpdateVolumeReadonlyOption object

The read-only setting marker.

Table 4 CinderUpdateVolumeReadonlyOption

Parameter

Mandatory

Type

Description

readonly

Yes

Boolean

Whether the disk is read-only. true: The disk is read-only. false: The disk is not read-only.

Default: true

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.

Table 6 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

Setting the read-only flag for an EVS disk

POST https://{endpoint}/v2/{project_id}/volumes/{volume_id}/action

{
  "os-update_readonly_flag" : {
    "readonly" : true
  }
}

Example Responses

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

Error Codes

See Error Codes.