Dynamic Unmounting of Notebook Storage

Function

This API is used to dynamically unmount a dynamic storage instance from a running notebook instance.

It is used when you need to clear or reorganize the mounted resources of a notebook instance. You can use this API to unmount a specified storage instance. Before using this API, ensure that you have logged in to the system and have the permission to access the target notebook instance. The notebook instance must be running and the storage instance must be in the MOUNTED, UNMOUNT_FAILED, or MOUNT_FAILED state. After this API is called, the system unmounts the specified storage instance. The notebook container cannot perform operations on the files or objects in the storage, which remain unchanged. If you do not have the permission to access the specified instance or the notebook instance is not running, an error message is returned.

Constraints

No constraints

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition: Notebook instance ID. The ID is in the format of a Universally Unique Identifier (UUID). For details about how to obtain the ID, see Querying Notebook Instances. Constraints: N/A Range: N/A Default Value: N/A
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A
storage_id	Yes	String	Definition: Storage ID. The ID is in UUID format. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
category	String	Definition: Storage type. The value can be OBS, OBSFS, or EFS. Range: N/A
id	String	Definition: ID of the dynamically mounted instance. Range: N/A
mount_path	String	Definition: Path mounted to the notebook instance. Range: N/A
status	String	Definition: Dynamic mounting status. Range MOUNTING: being mounted MOUNT_FAILED: mounting failed MOUNTED: mounted UNMOUNTING: being unmounted UNMOUNT_FAILED: unmounting failed UNMOUNTED: unmounted
uri	String	Definition: Storage path. Range: N/A
failure_reason	String	Definition: Mounting failure cause. This parameter is returned when the dynamic mounting status is MOUNT_FAILED. Range: N/A
efs_id	String	Definition: EFS storage instance ID. Range: N/A
mount_type	String	Definition: Storage mount type. Range: The value can be: STATIC: Storage cannot be mounted or unmounted when the instance is running. DYNAMIC: Storage can be mounted and unmounted when the instance is running.

Status code: 204

No content

Example Requests

DELETE https://{endpoint}/v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

Example Responses

Status code: 200

{
  "category" : "OBSFS",
  "id" : "91dd2d3f-2d92-475f-a375-04636af26cc9",
  "mount_path" : "/data/mnt/pfs/",
  "status" : "UNMOUNTING",
  "uri" : "obs://pfs-name/dir/to/mount/"
}