Unmounting OBS Storage from a Notebook Instance

Function

This API is used to unmount an OBS parallel file system from a running notebook instance.

This API applies to the following scenario: When you need to clear or reorganize the resources mounted to a notebook instance, you can use this API to unmount an OBS parallel file system from the instance. Before using this API, ensure that you have logged in to the system and have the permission to access the target notebook instance and OBS parallel file system. In addition, the notebook instance must be running, and have an OBS parallel file system mounted. After this API is called, the system unmounts the specified OBS parallel file system from the notebook instance. The notebook container cannot operate objects in OBS, but objects in OBS remain unchanged. If you do not have the permission to access the specified notebook instance or the notebook instance is not running, the API will return an error message.

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.

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: OBS storage ID. The ID is in the format of a Universally Unique Identifier (UUID). 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. 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: Status of dynamically mounted OBS storage. Range: MOUNTING: being mounted MOUNT_FAILED: mounting failed MOUNTED: mounted UNMOUNTING: being unmounted UNMOUNT_FAILED: unmounting failed UNMOUNTED: unmounted
uri	String	Definition: OBS object path. Range: N/A

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/wang/",
  "status" : "UNMOUNTING",
  "uri" : "obs://authoring-test/wang/"
}