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
Debugging¶
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
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 and Name. |
storage_id | Yes | String | OBS storage ID. |
Request Parameters¶
None
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¶
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.