• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk Actions
  6. Setting Read-Only Flag for an EVS Disk

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

    Specifies the project ID.

    volume_id

    Yes

    Specifies the disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    os-update_readonly_flag

    map<string, Boolean>

    Yes

    Specifies 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

    Specifies the read-only flag.

  • Example request
    {
        "os-update_readonly_flag": {
            "readonly": true
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    error

    string

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    string

    Specifies the error message returned when an error occurs.

    code

    string

    Specifies the error code returned when 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"
        }
    }

Returned Values

  • Normal

    202

Error Codes

For details, see Error Codes.