Lai, Weijian 68e5cd0687 ModelArts API 23.3.0 Version.

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>

2024-06-18 11:02:37 +00:00

10 KiB

Raw Permalink Blame History

OBS Storage Mounting

Function

An OBS parallel file system can be mounted to a specified file directory of a running notebook instance. After the mounting, objects in the OBS parallel file system can be read and written in the container as a file system.

Constraints

None

Debugging

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

URI

POST /v1/{project_id}/notebooks/{instance_id}/storage

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Notebook instance ID.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
category	No	String	Storage category. Options: OBS
mount_path	No	String	Path where OBS storage is mounted, which must be in a subdirectory of /data/ of the notebook instance.
uri	No	String	OBS object path, for example, obs://modelarts/notebook/

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
category	String	Storage category. Options: OBS
id	String	ID of the instance with OBS storage mounted.
mount_path	String	Path where OBS storage is mounted to a notebook instance.
status	String	Status of OBS storage to be mounted. Options: MOUNTING: being mounted MOUNT_FAILED: mounting failed MOUNTED: mounted UNMOUNTING: being unmounted UNMOUNT_FAILED: unmounting failed UNMOUNTED: unmounted
uri	String	OBS object path

Example Requests

{
  "category" : "OBS",
  "mount_path" : "/data/wang/",
  "uri" : "obs://authoring-test/wang/"
}

Example Responses