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
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¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
category | No | String | Storage category. Options:
|
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
Parameter | Type | Description |
|---|---|---|
category | String | Storage category. Options:
|
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:
|
uri | String | OBS object path |
Example Requests¶
{
"category" : "OBS",
"mount_path" : "/data/wang/",
"uri" : "obs://authoring-test/wang/"
}
Example Responses¶
Status code: 200
OK
{
"id" : "91dd2d3f-2d92-475f-a375-04636af26cc9",
"category" : "OBSFS",
"mount_path" : "/data/wang/",
"uri" : "obs://authoring-test/wang/",
"status" : "MOUNTING"
}
Status Codes¶
Status Code | Description |
|---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.