Updated on 2022-11-02 GMT+08:00

Setting Bootable Flag for an EVS Disk

Function

This API is used to set the bootable flag for an EVS disk.

Constraints

A data disk cannot be used as system disk for an ECS even if this API has been called to set the bootable flag for it.

URI

  • URI format

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

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

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

    volume_id

    Yes

    Specifies the disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    os-set_bootable

    Object

    Yes

    Specifies the disk bootable marker. For details, see Parameter in the os-set_bootable field.

  • Parameter in the os-set_bootable field

    Parameter

    Type

    Mandatory

    Description

    bootable

    Boolean

    Yes

    Specifies whether to set the bootable flag for the disk.

    • false: does not set the flag.
    • true: sets the flag.
  • Example request
    {
        "os-set_bootable": {
            "bootable": true
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    error

    Object

    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

    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

    200

Error Codes

For details, see Error Codes.