Oracle Cloud Infrastructure · JSON Structure

Compute Attach Volume Details Structure

Details for attaching a volume.

Type: object Properties: 5 Required: 3
Cloud ComputingEnterprise CloudInfrastructure as a ServiceOraclePlatform as a Service

AttachVolumeDetails is a JSON Structure definition published by Oracle Cloud Infrastructure, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

instanceId volumeId type displayName isReadOnly

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/compute-attach-volume-details-structure.json",
  "name": "AttachVolumeDetails",
  "description": "Details for attaching a volume.",
  "type": "object",
  "properties": {
    "instanceId": {
      "type": "string",
      "description": "The OCID of the instance.",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "volumeId": {
      "type": "string",
      "description": "The OCID of the volume.",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "type": {
      "type": "string",
      "description": "The type of volume attachment.",
      "enum": "['iscsi', 'paravirtualized']",
      "example": "iscsi"
    },
    "displayName": {
      "type": "string",
      "description": "A user-friendly name.",
      "example": "my-resource"
    },
    "isReadOnly": {
      "type": "boolean",
      "description": "Whether the attachment is read-only.",
      "default": false,
      "example": false
    }
  },
  "required": [
    "instanceId",
    "volumeId",
    "type"
  ]
}