REST API for Oracle AI Data Platform Workbench

Update a volume

put

/20260430/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}

Updates a volume with the provided information.

Request

Path Parameters

aiDataPlatformId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
volumeKey(required): string

The key of the volume.

Header Parameters

if-match: string

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
should-update-recent: boolean

A flag to identify if the recent list should be updated.

Default Value: false

The information to be updated.

Root Schema : UpdateVolumeDetails

Type: object

The data to update a volume.

Show Source

description: string

Short description of the volume
displayName: string

A user-friendly name. Has to be unique within the schema and is changeable.

{
    "description":"The data to update a volume.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Has to be unique within the schema and is changeable.",
            "type":"string"
        },
        "description":{
            "description":"Short description of the volume",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation. The volume is updated.

Headers

etag: string

For optimistic concurrency control. See `if-match`.
opc-request-id: string

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

The OCID of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request.

Root Schema : Volume

Type: object

A volumes is a container to store data in its original form and can store semi-structured or unstructured data. Volumes can either be external or managed. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see IAM Policies for Oracle AI Data Platform Workbench.

Show Source

catalogName: string

The name of the catalog to which this volume belongs.
createdBy: string

The ID of the user that created the volume.
description: string

Short description of the volume
displayName(required): string

A user-friendly name. Has to be unique within the schema and is changeable.
fullName: string

The fully qualified name of this volume.
key(required): string

The key of the volume.
lifecycleState: string

Allowed Values: [ "CREATING", "UPDATING", "DELETING", "ACTIVE", "DELETED" ]

The lifecycle state of the volume. The volume is ready for use in ACTIVE state
lifecycleStateDetails: string

Additional details associated with the lifecycle state.
schemaName: string

The name of the schema to which this volume belongs.
storageLocation: string

The storage location of the external volume. Only applicable for external volumes.
systemTags: object systemTags

Additional Properties Allowed: additionalProperties

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
timeCreated(required): string(date-time)

The date and time the Data Lake Volume was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
timeUpdated: string(date-time)

The date and time the Data Lake Volume was updated, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
updatedBy: string

The ID of the user that last updated the volume
volumeType: string

Default Value: MANAGED

Allowed Values: [ "MANAGED", "EXTERNAL" ]

The type of volume.

{
    "description":"A volumes is a container to store data in its original form and can store semi-structured or unstructured data.\nVolumes can either be external or managed. To use any of the API operations, you must be authorized in an IAM policy. \nIf you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give\nusers access, see <a href=\"https://docs.oracle.com/en/cloud/paas/ai-data-platform/aidug/iam-policies-oracle-ai-data-platform.html\" target=\"_blank\" rel=\"noopener noreferrer\">IAM Policies for Oracle AI Data Platform Workbench</a>.\n",
    "type":"object",
    "required":[
        "key",
        "timeCreated",
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"The key of the volume.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Has to be unique within the schema and is changeable.",
            "type":"string"
        },
        "description":{
            "description":"Short description of the volume",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the Data Lake Volume was created, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the Data Lake Volume was updated, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The ID of the user that created the volume.\n",
            "type":"string"
        },
        "updatedBy":{
            "description":"The ID of the user that last updated the volume\n",
            "type":"string"
        },
        "catalogName":{
            "description":"The name of the catalog to which this volume belongs.",
            "type":"string"
        },
        "schemaName":{
            "description":"The name of the schema to which this volume belongs.",
            "type":"string"
        },
        "fullName":{
            "description":"The fully qualified name of this volume.",
            "type":"string"
        },
        "volumeType":{
            "description":"The type of volume.",
            "type":"string",
            "enum":[
                "MANAGED",
                "EXTERNAL"
            ],
            "default":"MANAGED"
        },
        "storageLocation":{
            "description":"The storage location of the external volume. Only applicable for external volumes.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The lifecycle state of the volume. The volume is ready for use in ACTIVE state",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "DELETING",
                "ACTIVE",
                "DELETED"
            ]
        },
        "lifecycleStateDetails":{
            "description":"Additional details associated with the lifecycle state.",
            "type":"string"
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed. Request is recognized but not supported.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}