Oracle · Schema
VolumeAttachment
A base object for all types of volume attachments. Represents the attachment between a compute instance and a block volume.
CloudDatabaseEnterpriseInfrastructureSaaSFortune 100
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The OCID of the volume attachment |
| instanceId | string | The OCID of the instance the volume is attached to |
| volumeId | string | The OCID of the volume |
| compartmentId | string | The OCID of the compartment |
| availabilityDomain | string | The availability domain of an instance |
| displayName | string | A user-friendly name for the attachment |
| device | string | The device name (e.g., /dev/oracleoci/oraclevdb) |
| attachmentType | string | The type of volume attachment |
| lifecycleState | string | The lifecycle state of the volume attachment |
| timeCreated | string | The date and time the volume was attached |
| isReadOnly | boolean | Whether the attachment was created in read-only mode |
| isShareable | boolean | Whether the attachment should be created in shareable mode |
| isPvEncryptionInTransitEnabled | boolean | Whether in-transit encryption is enabled for the attachment |
| isMultipath | boolean | Whether the attachment is multipath |
| iscsiLoginState | string | The iSCSI login state of the volume attachment |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "VolumeAttachment",
"type": "object",
"description": "A base object for all types of volume attachments. Represents the attachment between a compute instance and a block volume.",
"properties": {
"id": {
"type": "string",
"description": "The OCID of the volume attachment"
},
"instanceId": {
"type": "string",
"description": "The OCID of the instance the volume is attached to"
},
"volumeId": {
"type": "string",
"description": "The OCID of the volume"
},
"compartmentId": {
"type": "string",
"description": "The OCID of the compartment"
},
"availabilityDomain": {
"type": "string",
"description": "The availability domain of an instance"
},
"displayName": {
"type": "string",
"description": "A user-friendly name for the attachment"
},
"device": {
"type": "string",
"description": "The device name (e.g., /dev/oracleoci/oraclevdb)"
},
"attachmentType": {
"type": "string",
"description": "The type of volume attachment"
},
"lifecycleState": {
"type": "string",
"description": "The lifecycle state of the volume attachment"
},
"timeCreated": {
"type": "string",
"description": "The date and time the volume was attached"
},
"isReadOnly": {
"type": "boolean",
"description": "Whether the attachment was created in read-only mode"
},
"isShareable": {
"type": "boolean",
"description": "Whether the attachment should be created in shareable mode"
},
"isPvEncryptionInTransitEnabled": {
"type": "boolean",
"description": "Whether in-transit encryption is enabled for the attachment"
},
"isMultipath": {
"type": "boolean",
"description": "Whether the attachment is multipath"
},
"iscsiLoginState": {
"type": "string",
"description": "The iSCSI login state of the volume attachment"
}
}
}