Setting Read-Only Flag for an EVS Disk
Function
This API is used to set the read-only flag for the EVS disk.
URI
- URI format
POST /v2/{project_id}/volumes/{volume_id}/action
- Parameter description
Parameter
Mandatory
Description
project_id
Yes
The project ID.
For details about how to obtain the project ID, see Obtaining a Project ID.
volume_id
Yes
The disk ID.
Request
- Parameter description
Parameter
Type
Mandatory
Description
os-update_readonly_flag
Object
Yes
The disk read-only flag. For details, see Parameter in the os-update_readonly_flag field.
- Parameter in the os-update_readonly_flag field
Parameter
Type
Mandatory
Description
readonly
Boolean
Yes
The read-only flag.
- true: The disk is read-only.
- false: The disk is not read-only.
- Example request{"os-update_readonly_flag": {"readonly": true}}
Response
- Parameter description
Parameter
Type
Description
error
Object
The error message returned if an error occurs. For details, see Parameters in the error field.
- Parameters in the error field
Parameter
Type
Description
message
String
The error message returned if an error occurs.
code
String
The error code returned if an error occurs.
For details about the error code, see Error Codes.
- Example response
None
or
{"error": {"message": "XXXX","code": "XXX"}}In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:
{"itemNotFound": {"message": "XXXX","code": "XXX"}}
Status Codes
- Normal
202
Error Codes
For details, see Error Codes.
- Function
- URI
- Request
- Response
- Status Codes
- Error Codes