Lai, Weijian
2f0818cf3d
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>
7.4 KiB
Obtaining Details About a Notebook Instance with OBS Storage Mounted
Function
This API is used to obtain details about a notebook instance with OBS storage mounted.
Constraints
None
URI
GET /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
instance_id |
Yes |
String |
Notebook instance ID. |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
storage_id |
Yes |
String |
OBS storage ID. |
Request Parameters
None
Response Parameters
Status code: 200
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: \r\n-MOUNTING: OBS storage is being mounted. \r\n-MOUNT_FAILED: OBS storage fails to be mounted. \r\n-MOUNTED: OBS storage is mounted. \r\n-UNMOUNTING: OBS storage is being unmounted.\r\n-UNMOUNT_FAILED: OBS storage fails to be unmounted.\r\n-UNMOUNTED: OBS is unmounted. |
uri |
String |
OBS parallel file system path. |
Example Requests
None
Example Responses
Status code: 200
OK
{
"id" : "91dd2d3f-2d92-475f-a375-04636af26cc9",
"category" : "OBSFS",
"mount_path" : "/data/wang/",
"uri" : "obs://authoring-test/wang/",
"status" : "MOUNTED"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.