Jump to

• Request
• Response

Attach Boot Volume

post

/20160918/bootVolumeAttachments

Attach the specified boot volume to the specified instance.

Request

Supported Media Types

• application/json

Header Parameters

• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

Attach boot volume request

Root Schema : AttachBootVolumeDetails

Type: object

Show Source

• bootVolumeId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the boot volume.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• encryptionInTransitType: string
  Default Value: NONE

  Allowed Values: [ "NONE", "BM_ENCRYPTION_IN_TRANSIT" ]

  Refer the top-level definition of encryptionInTransitType. The default value is NONE.
• instanceId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance.

{
    "properties":{
        "bootVolumeId":{
            "description":"The OCID of the  boot volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "instanceId":{
            "description":"The OCID of the instance.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "encryptionInTransitType":{
            "description":"Refer the top-level definition of encryptionInTransitType. The default value is NONE.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/EncryptionInTransitType",
            "enum":[
                "NONE",
                "BM_ENCRYPTION_IN_TRANSIT"
            ],
            "default":"NONE"
        }
    },
    "required":[
        "instanceId",
        "bootVolumeId"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The boot volume is being attached.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : BootVolumeAttachment

Type: object

Represents an attachment between a boot volume and an instance. Avoid entering confidential information.

Show Source

• attachmentType: string
  Minimum Length: 1

  Maximum Length: 255

  The type of boot volume attachment.
• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of an instance. For Oracle Private Cloud Appliance, the availability domain is AD-1.
• bootVolumeId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the boot volume.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• encryptionInTransitType: string
  Default Value: NONE

  Allowed Values: [ "NONE", "BM_ENCRYPTION_IN_TRANSIT" ]

  Refer the top-level definition of encryptionInTransitType. The default value is NONE.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the boot volume attachment.
• instanceId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance the boot volume is attached to.
• isEncryptionInTransitEnabled: boolean
  Specifies whether in-transit encryption is enabled for the boot volume's attachment.
• isPvEncryptionInTransitEnabled: boolean
  Deprecated. Use isEncryptionInTransitEnabled instead.
• lifecycleState(required): string
  Allowed Values: [ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]

  The current state of the boot volume attachment.
• timeCreated(required): string(date-time)
  The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
• timeUpdated: string(date-time)
  The date and time the boot volume attachment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

{
    "x-obmcs-splat":{
        "resourceKind":"BootVolumeAttachment",
        "adLocality":"ad-local"
    },
    "description":"Represents an attachment between a boot volume and an instance. Avoid entering confidential information.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of an instance. For Oracle Private Cloud Appliance, the availability domain is AD-1.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "bootVolumeId":{
            "description":"The OCID of the boot volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "id":{
            "description":"The OCID of the boot volume attachment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "instanceId":{
            "description":"The OCID of the instance the boot volume is attached to.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the boot volume attachment.",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "timeUpdated":{
            "description":"The date and time the boot volume attachment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "attachmentType":{
            "description":"The type of boot volume attachment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "isPvEncryptionInTransitEnabled":{
            "description":"Deprecated. Use isEncryptionInTransitEnabled instead.",
            "type":"boolean"
        },
        "isEncryptionInTransitEnabled":{
            "description":"Specifies whether in-transit encryption is enabled for the boot volume's attachment.",
            "type":"boolean"
        },
        "encryptionInTransitType":{
            "description":"Refer the top-level definition of encryptionInTransitType. The default value is NONE.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/EncryptionInTransitType",
            "enum":[
                "NONE",
                "BM_ENCRYPTION_IN_TRANSIT"
            ],
            "default":"NONE"
        }
    },
    "required":[
        "id",
        "instanceId",
        "bootVolumeId",
        "lifecycleState",
        "compartmentId",
        "availabilityDomain",
        "timeCreated"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top